1# -*- coding: utf-8 -*- 2# flake8: noqa 3# 4# pyzfs documentation build configuration file, created by 5# sphinx-quickstart on Mon Apr 6 23:48:40 2015. 6# 7# This file is execfile()d with the current directory set to its 8# containing dir. 9# 10# Note that not all possible configuration values are present in this 11# autogenerated file. 12# 13# All configuration values have a default; values that are commented out 14# serve to show the default. 15 16import sys 17import os 18 19# If extensions (or modules to document with autodoc) are in another directory, 20# add these directories to sys.path here. If the directory is relative to the 21# documentation root, use os.path.abspath to make it absolute, like shown here. 22sys.path.insert(0, os.path.abspath('../..')) 23 24# -- General configuration ------------------------------------------------ 25 26# If your documentation needs a minimal Sphinx version, state it here. 27#needs_sphinx = '1.0' 28 29# Add any Sphinx extension module names here, as strings. They can be 30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 31# ones. 32extensions = [ 33 'sphinx.ext.autodoc', 34] 35 36# Add any paths that contain templates here, relative to this directory. 37templates_path = ['_templates'] 38 39# The suffix(es) of source filenames. 40# You can specify multiple suffix as a list of string: 41# source_suffix = ['.rst', '.md'] 42source_suffix = '.rst' 43 44# The encoding of source files. 45#source_encoding = 'utf-8-sig' 46 47# The master toctree document. 48master_doc = 'index' 49 50# General information about the project. 51project = u'pyzfs' 52copyright = u'2015, ClusterHQ' 53author = u'ClusterHQ' 54 55# The version info for the project you're documenting, acts as replacement for 56# |version| and |release|, also used in various other places throughout the 57# built documents. 58# 59# The short X.Y version. 60version = '0.2.3' 61# The full version, including alpha/beta/rc tags. 62release = '0.2.3' 63 64# The language for content autogenerated by Sphinx. Refer to documentation 65# for a list of supported languages. 66# 67# This is also used if you do content translation via gettext catalogs. 68# Usually you set "language" from the command line for these cases. 69language = None 70 71# There are two options for replacing |today|: either, you set today to some 72# non-false value, then it is used: 73#today = '' 74# Else, today_fmt is used as the format for a strftime call. 75#today_fmt = '%B %d, %Y' 76 77# List of patterns, relative to source directory, that match files and 78# directories to ignore when looking for source files. 79exclude_patterns = [] 80 81# The reST default role (used for this markup: `text`) to use for all 82# documents. 83#default_role = None 84 85# If true, '()' will be appended to :func: etc. cross-reference text. 86#add_function_parentheses = True 87 88# If true, the current module name will be prepended to all description 89# unit titles (such as .. function::). 90#add_module_names = True 91 92# If true, sectionauthor and moduleauthor directives will be shown in the 93# output. They are ignored by default. 94#show_authors = False 95 96# The name of the Pygments (syntax highlighting) style to use. 97pygments_style = 'sphinx' 98 99# A list of ignored prefixes for module index sorting. 100#modindex_common_prefix = [] 101 102# If true, keep warnings as "system message" paragraphs in the built documents. 103#keep_warnings = False 104 105# If true, `todo` and `todoList` produce output, else they produce nothing. 106todo_include_todos = False 107 108 109# -- Options for HTML output ---------------------------------------------- 110 111# The theme to use for HTML and HTML Help pages. See the documentation for 112# a list of builtin themes. 113html_theme = 'classic' 114 115# Theme options are theme-specific and customize the look and feel of a theme 116# further. For a list of options available for each theme, see the 117# documentation. 118#html_theme_options = {} 119 120# Add any paths that contain custom themes here, relative to this directory. 121#html_theme_path = [] 122 123# The name for this set of Sphinx documents. If None, it defaults to 124# "<project> v<release> documentation". 125#html_title = None 126 127# A shorter title for the navigation bar. Default is the same as html_title. 128#html_short_title = None 129 130# The name of an image file (relative to this directory) to place at the top 131# of the sidebar. 132#html_logo = None 133 134# The name of an image file (within the static path) to use as favicon of the 135# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 136# pixels large. 137#html_favicon = None 138 139# Add any paths that contain custom static files (such as style sheets) here, 140# relative to this directory. They are copied after the builtin static files, 141# so a file named "default.css" will overwrite the builtin "default.css". 142html_static_path = ['_static'] 143 144# Add any extra paths that contain custom files (such as robots.txt or 145# .htaccess) here, relative to this directory. These files are copied 146# directly to the root of the documentation. 147#html_extra_path = [] 148 149# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 150# using the given strftime format. 151#html_last_updated_fmt = '%b %d, %Y' 152 153# If true, SmartyPants will be used to convert quotes and dashes to 154# typographically correct entities. 155#html_use_smartypants = True 156 157# Custom sidebar templates, maps document names to template names. 158#html_sidebars = {} 159 160# Additional templates that should be rendered to pages, maps page names to 161# template names. 162#html_additional_pages = {} 163 164# If false, no module index is generated. 165#html_domain_indices = True 166 167# If false, no index is generated. 168#html_use_index = True 169 170# If true, the index is split into individual pages for each letter. 171#html_split_index = False 172 173# If true, links to the reST sources are added to the pages. 174#html_show_sourcelink = True 175 176# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 177#html_show_sphinx = True 178 179# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 180#html_show_copyright = True 181 182# If true, an OpenSearch description file will be output, and all pages will 183# contain a <link> tag referring to it. The value of this option must be the 184# base URL from which the finished HTML is served. 185#html_use_opensearch = '' 186 187# This is the file name suffix for HTML files (e.g. ".xhtml"). 188#html_file_suffix = None 189 190# Language to be used for generating the HTML full-text search index. 191# Sphinx supports the following languages: 192# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' 193# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' 194#html_search_language = 'en' 195 196# A dictionary with options for the search language support, empty by default. 197# Now only 'ja' uses this config value 198#html_search_options = {'type': 'default'} 199 200# The name of a javascript file (relative to the configuration directory) that 201# implements a search results scorer. If empty, the default will be used. 202#html_search_scorer = 'scorer.js' 203 204# Output file base name for HTML help builder. 205htmlhelp_basename = 'pyzfsdoc' 206 207# -- Options for LaTeX output --------------------------------------------- 208 209latex_elements = { 210# The paper size ('letterpaper' or 'a4paper'). 211#'papersize': 'letterpaper', 212 213# The font size ('10pt', '11pt' or '12pt'). 214#'pointsize': '10pt', 215 216# Additional stuff for the LaTeX preamble. 217#'preamble': '', 218 219# Latex figure (float) alignment 220#'figure_align': 'htbp', 221} 222 223# Grouping the document tree into LaTeX files. List of tuples 224# (source start file, target name, title, 225# author, documentclass [howto, manual, or own class]). 226latex_documents = [ 227 (master_doc, 'pyzfs.tex', u'pyzfs Documentation', 228 u'ClusterHQ', 'manual'), 229] 230 231# The name of an image file (relative to this directory) to place at the top of 232# the title page. 233#latex_logo = None 234 235# For "manual" documents, if this is true, then toplevel headings are parts, 236# not chapters. 237#latex_use_parts = False 238 239# If true, show page references after internal links. 240#latex_show_pagerefs = False 241 242# If true, show URL addresses after external links. 243#latex_show_urls = False 244 245# Documents to append as an appendix to all manuals. 246#latex_appendices = [] 247 248# If false, no module index is generated. 249#latex_domain_indices = True 250 251 252# -- Options for manual page output --------------------------------------- 253 254# One entry per manual page. List of tuples 255# (source start file, name, description, authors, manual section). 256man_pages = [ 257 (master_doc, 'pyzfs', u'pyzfs Documentation', 258 [author], 1) 259] 260 261# If true, show URL addresses after external links. 262#man_show_urls = False 263 264 265# -- Options for Texinfo output ------------------------------------------- 266 267# Grouping the document tree into Texinfo files. List of tuples 268# (source start file, target name, title, author, 269# dir menu entry, description, category) 270texinfo_documents = [ 271 (master_doc, 'pyzfs', u'pyzfs Documentation', 272 author, 'pyzfs', 'One line description of project.', 273 'Miscellaneous'), 274] 275 276# Documents to append as an appendix to all manuals. 277#texinfo_appendices = [] 278 279# If false, no module index is generated. 280#texinfo_domain_indices = True 281 282# How to display URL addresses: 'footnote', 'no', or 'inline'. 283#texinfo_show_urls = 'footnote' 284 285# If true, do not generate a @detailmenu in the "Top" node's menu. 286#texinfo_no_detailmenu = False 287 288# Sort documentation in the same order as the source files. 289autodoc_member_order = 'bysource' 290 291 292####################### 293# Neutralize effects of function wrapping on documented signatures. 294# The affected signatures could be explicitly placed into the 295# documentation (either in .rst files or as a first line of a 296# docstring). 297import functools 298 299def no_op_wraps(func): 300 def wrapper(decorator): 301 return func 302 return wrapper 303 304functools.wraps = no_op_wraps 305