diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 115 |
1 files changed, 62 insertions, 53 deletions
diff --git a/docs/conf.py b/docs/conf.py index c04eaa3..cf0ff9b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ # If your extensions are in another directory, add it here. If the # directory is relative to the documentation root, use os.path.abspath to # make it absolute, like shown here. -#sys.path.append(os.path.abspath('some/directory')) +# sys.path.append(os.path.abspath('some/directory')) import datetime import pkg_resources @@ -27,68 +27,70 @@ import pylons_sphinx_themes # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", ] intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), + "python": ("https://docs.python.org/3/", None), } # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General substitutions. -project = 'waitress' +project = "waitress" thisyear = datetime.datetime.now().year -copyright = '2012-%s, Agendaless Consulting <chrism@plope.com>' % thisyear +copyright = "2012-%s, Agendaless Consulting <chrism@plope.com>" % thisyear # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. # # The short X.Y version. -version = pkg_resources.get_distribution('waitress').version +version = pkg_resources.get_distribution("waitress").version # The full version, including alpha/beta/rc tags. release = version # There are two options for replacing |today|: either, you set today to # some non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -today_fmt = '%B %d, %Y' +today_fmt = "%B %d, %Y" # List of documents that shouldn't be included in the build. -#unused_docs = [] +# unused_docs = [] # List of directories, relative to source directories, that shouldn't be # searched for source files. -#exclude_dirs = [] -exclude_patterns = ['_themes/README.rst',] +# exclude_dirs = [] +exclude_patterns = [ + "_themes/README.rst", +] # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # Do not use smart quotes. smartquotes = False @@ -98,9 +100,9 @@ smartquotes = False # ----------------------- # Add and use Pylons theme -html_theme = 'pylons' +html_theme = "pylons" html_theme_path = pylons_sphinx_themes.get_html_themes_path() -html_theme_options = dict(github_url='https://github.com/Pylons/waitress') +html_theme_options = dict(github_url="https://github.com/Pylons/waitress") # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths @@ -109,11 +111,11 @@ html_theme_options = dict(github_url='https://github.com/Pylons/waitress') # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as # html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (within the static path) to place at the top of # the sidebar. @@ -122,92 +124,99 @@ html_theme_options = dict(github_url='https://github.com/Pylons/waitress') # The name of an image file (within the static path) to use as favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or # 32x32 pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) # here, relative to this directory. They are copied after the builtin # static files, so a file named "default.css" will overwrite the builtin # "default.css". -#html_static_path = ['.static'] +# html_static_path = ['.static'] # If not '', a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = "%b %d, %Y" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_use_modindex = True +# html_use_modindex = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, the reST sources are included in the HTML build as # _sources/<name>. -#html_copy_source = True +# html_copy_source = True # If true, an OpenSearch description file will be output, and all pages # will contain a <link> tag referring to it. The value of this option must # be the base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'waitress' +htmlhelp_basename = "waitress" # Control display of sidebars -html_sidebars = {'**': [ - 'localtoc.html', - 'ethicalads.html', - 'relations.html', - 'sourcelink.html', - 'searchbox.html', -]} +html_sidebars = { + "**": [ + "localtoc.html", + "ethicalads.html", + "relations.html", + "sourcelink.html", + "searchbox.html", + ] +} # Options for LaTeX output # ------------------------ # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, document class [howto/manual]). latex_documents = [ - ('index', 'waitress.tex', 'waitress Documentation', - 'Pylons Project Developers', 'manual'), + ( + "index", + "waitress.tex", + "waitress Documentation", + "Pylons Project Developers", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the # top of the title page. -#latex_logo = '.static/logo_hi.gif' +# latex_logo = '.static/logo_hi.gif' # For "manual" documents, if this is true, then toplevel headings are # parts, not chapters. -#latex_use_parts = False +# latex_use_parts = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True |