diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 157 |
1 files changed, 136 insertions, 21 deletions
diff --git a/docs/conf.py b/docs/conf.py index ef47a45..3edb819 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,37 +1,152 @@ -# -*- coding: utf-8 -*- import pkg_resources +import sys +import os +import shlex + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', +] + +# Add any paths that contain templates here, relative to this directory. +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'] + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'WebOb' +copyright = u'2015, Ian Bicking and contributors' +author = u'Ian Bicking and contributors' version = release = pkg_resources.get_distribution('webob').version -extensions = ['sphinx.ext.autodoc'] +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +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/*'] -source_suffix = '.txt' # The suffix of source filenames. -master_doc = 'index' # The master toctree document. +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' -project = 'WebOb' -copyright = '2011, Ian Bicking and contributors' -exclude_patterns = ['jsonrpc-example-code/*'] +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False modindex_common_prefix = ['webob.'] -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# -- Options for HTML output --------------------------------------------- -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True +html_theme = 'alabaster' +html_static_path = ['_static'] -# html_favicon = ... -html_add_permalinks = "False" -#html_show_sourcelink = True # ?set to False? +htmlhelp_basename = 'WebObdoc' -# Content template for the index page. -#html_index = '' +# -- Options for LaTeX output --------------------------------------------- -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', -# Output file base name for HTML help builder. -htmlhelp_basename = 'WebObdoc' +# 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'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#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) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (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'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +epub_exclude_files = ['search.html'] +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} |
