241 lines · python
1# -*- coding: utf-8 -*-2#3# Polly documentation build configuration file, created by4# sphinx-quickstart on Sun Dec 9 20:01:55 2013.5#6# This file is execfile()d with the current directory set to its containing dir.7#8# Note that not all possible configuration values are present in this9# autogenerated file.10#11# All configuration values have a default; values that are commented out12# serve to show the default.13 14import sys, os15from datetime import date16 17# If extensions (or modules to document with autodoc) are in another directory,18# add these directories to sys.path here. If the directory is relative to the19# documentation root, use os.path.abspath to make it absolute, like shown here.20# sys.path.insert(0, os.path.abspath('.'))21 22# -- General configuration -----------------------------------------------------23 24# If your documentation needs a minimal Sphinx version, state it here.25# needs_sphinx = '1.0'26 27# Add any Sphinx extension module names here, as strings. They can be extensions28# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.29extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax"]30 31# Add any paths that contain templates here, relative to this directory.32templates_path = ["_templates"]33 34# The suffix of source filenames.35source_suffix = ".rst"36 37# The encoding of source files.38# source_encoding = 'utf-8-sig'39 40# The master toctree document.41master_doc = "index"42 43# General information about the project.44project = "Polly"45copyright = "2010-%d, The Polly Team" % date.today().year46 47# The language for content autogenerated by Sphinx. Refer to documentation48# for a list of supported languages.49# language = None50 51# There are two options for replacing |today|: either, you set today to some52# non-false value, then it is used:53# today = ''54# Else, today_fmt is used as the format for a strftime call.55# today_fmt = '%B %d, %Y'56 57# List of patterns, relative to source directory, that match files and58# directories to ignore when looking for source files.59exclude_patterns = ["_build", "analyzer"]60 61# The reST default role (used for this markup: `text`) to use for all documents.62# default_role = None63 64# If true, '()' will be appended to :func: etc. cross-reference text.65# add_function_parentheses = True66 67# If true, the current module name will be prepended to all description68# unit titles (such as .. function::).69# add_module_names = True70 71# If true, sectionauthor and moduleauthor directives will be shown in the72# output. They are ignored by default.73# show_authors = False74 75# The name of the Pygments (syntax highlighting) style to use.76pygments_style = "friendly"77 78# A list of ignored prefixes for module index sorting.79# modindex_common_prefix = []80 81in_progress_title = "(In-Progress) " if tags.has("PreRelease") else ""82 83rst_epilog = f"""84.. |ReleaseNotesTitle| replace:: {in_progress_title} Release Notes85"""86 87# -- Options for HTML output ---------------------------------------------------88 89# The theme to use for HTML and HTML Help pages. See the documentation for90# a list of builtin themes.91try:92 import sphinx_rtd_theme93 94 html_theme = "sphinx_rtd_theme"95 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]96except ImportError:97 html_theme = "haiku"98 99 100# Theme options are theme-specific and customize the look and feel of a theme101# further. For a list of options available for each theme, see the102# documentation.103# html_theme_options = {}104 105# Add any paths that contain custom themes here, relative to this directory.106# html_theme_path = []107 108# The name for this set of Sphinx documents. If None, it defaults to109# "<project> v<release> documentation".110# html_title = None111 112# A shorter title for the navigation bar. Default is the same as html_title.113# html_short_title = None114 115# The name of an image file (relative to this directory) to place at the top116# of the sidebar.117# html_logo = None118 119# The name of an image file (within the static path) to use as favicon of the120# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32121# pixels large.122# html_favicon = None123 124# Add any paths that contain custom static files (such as style sheets) here,125# relative to this directory. They are copied after the builtin static files,126# so a file named "default.css" will overwrite the builtin "default.css".127html_static_path = []128 129# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,130# using the given strftime format.131# html_last_updated_fmt = '%b %d, %Y'132 133# If true, SmartyPants will be used to convert quotes and dashes to134# typographically correct entities.135# html_use_smartypants = True136 137# Custom sidebar templates, maps document names to template names.138# html_sidebars = {}139 140# Additional templates that should be rendered to pages, maps page names to141# template names.142# html_additional_pages = {}143 144# If false, no module index is generated.145# html_domain_indices = True146 147# If false, no index is generated.148# html_use_index = True149 150# If true, the index is split into individual pages for each letter.151# html_split_index = False152 153# If true, links to the reST sources are added to the pages.154# html_show_sourcelink = True155 156# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.157# html_show_sphinx = True158 159# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.160# html_show_copyright = True161 162# If true, an OpenSearch description file will be output, and all pages will163# contain a <link> tag referring to it. The value of this option must be the164# base URL from which the finished HTML is served.165# html_use_opensearch = ''166 167# This is the file name suffix for HTML files (e.g. ".xhtml").168# html_file_suffix = None169 170# Output file base name for HTML help builder.171htmlhelp_basename = "Pollydoc"172 173 174# -- Options for LaTeX output --------------------------------------------------175 176latex_elements = {177 # The paper size ('letterpaper' or 'a4paper').178 #'papersize': 'letterpaper',179 # The font size ('10pt', '11pt' or '12pt').180 #'pointsize': '10pt',181 # Additional stuff for the LaTeX preamble.182 #'preamble': '',183}184 185# Grouping the document tree into LaTeX files. List of tuples186# (source start file, target name, title, author, documentclass [howto/manual]).187latex_documents = [188 ("index", "Polly.tex", "Polly Documentation", "The Polly Team", "manual"),189]190 191# The name of an image file (relative to this directory) to place at the top of192# the title page.193# latex_logo = None194 195# For "manual" documents, if this is true, then toplevel headings are parts,196# not chapters.197# latex_use_parts = False198 199# If true, show page references after internal links.200# latex_show_pagerefs = False201 202# If true, show URL addresses after external links.203# latex_show_urls = False204 205# Documents to append as an appendix to all manuals.206# latex_appendices = []207 208# If false, no module index is generated.209# latex_domain_indices = True210 211 212# If true, show URL addresses after external links.213# man_show_urls = False214 215 216# -- Options for Texinfo output ------------------------------------------------217 218# Grouping the document tree into Texinfo files. List of tuples219# (source start file, target name, title, author,220# dir menu entry, description, category)221texinfo_documents = [222 (223 "index",224 "Polly",225 "Polly Documentation",226 "The Polly Team",227 "Polly",228 "One line description of project.",229 "Miscellaneous",230 ),231]232 233# Documents to append as an appendix to all manuals.234# texinfo_appendices = []235 236# If false, no module index is generated.237# texinfo_domain_indices = True238 239# How to display URL addresses: 'footnote', 'no', or 'inline'.240# texinfo_show_urls = 'footnote'241