diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 107 |
1 files changed, 56 insertions, 51 deletions
diff --git a/docs/conf.py b/docs/conf.py index 914d0f9..db67971 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,30 +4,30 @@ import os import shlex extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = ['.txt', '.rst'] +source_suffix = [".txt", ".rst"] # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'WebOb' -copyright = u'2018, Ian Bicking, Pylons Project and contributors' -author = u'Ian Bicking, Pylons Project, and contributors' +project = "WebOb" +copyright = "2018, Ian Bicking, Pylons Project and contributors" +author = "Ian Bicking, Pylons Project, and contributors" -version = release = pkg_resources.get_distribution('webob').version +version = release = pkg_resources.get_distribution("webob").version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -38,84 +38,83 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', 'jsonrpc-example-code/*', 'file-example-code/*'] +exclude_patterns = ["_build", "jsonrpc-example-code/*", "file-example-code/*"] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False -modindex_common_prefix = ['webob.'] +modindex_common_prefix = ["webob."] -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" # -- Options for HTML output --------------------------------------------- -html_theme = 'alabaster' +html_theme = "alabaster" -html_static_path = ['_static'] +html_static_path = ["_static"] -htmlhelp_basename = 'WebObdoc' +htmlhelp_basename = "WebObdoc" -smartquotes=False +smartquotes = False # -- Options for LaTeX output --------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + #'preamble': '', + # Latex figure (float) alignment + #'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'WebOb.tex', u'WebOb Documentation', - u'Ian Bicking and contributors', 'manual'), + ( + master_doc, + "WebOb.tex", + "WebOb Documentation", + "Ian Bicking and contributors", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'webob', u'WebOb Documentation', - [author], 1) -] +man_pages = [(master_doc, "webob", "WebOb Documentation", [author], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -124,22 +123,28 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'WebOb', u'WebOb Documentation', - author, 'WebOb', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "WebOb", + "WebOb Documentation", + author, + "WebOb", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False # -- Options for Epub output ---------------------------------------------- @@ -150,9 +155,9 @@ epub_author = author epub_publisher = author epub_copyright = copyright -epub_exclude_files = ['search.html'] +epub_exclude_files = ["search.html"] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'python': ('https://docs.python.org/3', None), + "python": ("https://docs.python.org/3", None), } |