Permalink
Cannot retrieve contributors at this time
| # -*- coding: utf-8 -*- | |
| # | |
| # Python Developer's Guide documentation build configuration file, created by | |
| # sphinx-quickstart on Tue Jan 4 10:34:03 2011. | |
| # | |
| # This file is execfile()d with the current directory set to its containing dir. | |
| # | |
| # Note that not all possible configuration values are present in this | |
| # autogenerated file. | |
| # | |
| # All configuration values have a default; values that are commented out | |
| # serve to show the default. | |
| import os | |
| import sys | |
| import time | |
| # If extensions (or modules to document with autodoc) are in another directory, | |
| # add these directories to sys.path here. If the directory is relative to the | |
| # documentation root, use os.path.abspath to make it absolute, like shown here. | |
| #sys.path.insert(0, os.path.abspath('.')) | |
| sys.path.append(os.path.abspath('tools')) | |
| # -- General configuration ----------------------------------------------------- | |
| # If your documentation needs a minimal Sphinx version, state it here. | |
| #needs_sphinx = '1.0' | |
| # 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.intersphinx', 'sphinx.ext.todo', 'sphinx_copybutton'] | |
| intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} | |
| todo_include_todos = True | |
| # The suffix of source filenames. | |
| source_suffix = '.rst' | |
| # The encoding of source files. | |
| #source_encoding = 'utf-8-sig' | |
| # The master toctree document. | |
| master_doc = 'index' | |
| # General information about the project. | |
| project = 'Python Developer\'s Guide' | |
| copyright = '2011-%s, Python Software Foundation' % time.strftime('%Y') | |
| # The version info for the project you're documenting, acts as replacement for | |
| # |version| and |release|, also used in various other places throughout the | |
| # built documents. | |
| # | |
| # The short X.Y version. | |
| version = '' | |
| # The full version, including alpha/beta/rc tags. | |
| release = '' | |
| # The language for content autogenerated by Sphinx. Refer to documentation | |
| # for a list of supported languages. | |
| #language = None | |
| # There are two options for replacing |today|: either, you set today to some | |
| # non-false value, then it is used: | |
| #today = '' | |
| # Else, today_fmt is used as the format for a strftime call. | |
| #today_fmt = '%B %d, %Y' | |
| # List of patterns, relative to source directory, that match files and | |
| # directories to ignore when looking for source files. | |
| exclude_patterns = ['_build', 'venv*', 'env*', 'README.rst', '.github'] | |
| # The reST default role (used for this markup: `text`) to use for all documents. | |
| #default_role = None | |
| # If true, '()' will be appended to :func: etc. cross-reference text. | |
| #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 | |
| # If true, sectionauthor and moduleauthor directives will be shown in the | |
| # output. They are ignored by default. | |
| #show_authors = False | |
| # The name of the Pygments (syntax highlighting) style to use. | |
| pygments_style = 'sphinx' | |
| # A list of ignored prefixes for module index sorting. | |
| #modindex_common_prefix = [] | |
| # -- Options for HTML output --------------------------------------------------- | |
| # Use the upstream python-docs-theme | |
| html_theme = 'furo' | |
| html_theme_options = {} | |
| # The name for this set of Sphinx documents. If None, it defaults to | |
| # "<project> v<release> documentation". | |
| html_title = "%s %s" % (project, release) | |
| # Path to find HTML templates. | |
| templates_path = ['tools/templates'] | |
| # Additional static files. | |
| html_static_path = ['tools/static'] | |
| # A shorter title for the navigation bar. Default is the same as html_title. | |
| #html_short_title = None | |
| # The name of an image file (relative to this directory) to place at the top | |
| # of the sidebar. | |
| html_logo = "python-logo.png" | |
| # 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 | |
| # 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' | |
| # If true, SmartyPants will be used to convert quotes and dashes to | |
| # typographically correct entities. | |
| #html_use_smartypants = True | |
| # Additional templates that should be rendered to pages, maps page names to | |
| # template names. | |
| #html_additional_pages = {} | |
| # If false, no module index is generated. | |
| #html_domain_indices = True | |
| # If false, no index is generated. | |
| #html_use_index = True | |
| # If true, the index is split into individual pages for each letter. | |
| #html_split_index = False | |
| # If true, links to the reST sources are added to the pages. | |
| #html_show_sourcelink = True | |
| # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
| #html_show_sphinx = True | |
| # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
| #html_show_copyright = 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 = '' | |
| # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
| #html_file_suffix = None | |
| # Output file base name for HTML help builder. | |
| htmlhelp_basename = 'PythonDevelopersGuidedoc' | |
| # -- Options for LaTeX output -------------------------------------------------- | |
| # The paper size ('letter' or 'a4'). | |
| #latex_paper_size = 'letter' | |
| # The font size ('10pt', '11pt' or '12pt'). | |
| #latex_font_size = '10pt' | |
| # Grouping the document tree into LaTeX files. List of tuples | |
| # (source start file, target name, title, author, documentclass [howto/manual]). | |
| latex_documents = [ | |
| ( | |
| 'index', | |
| 'PythonDevelopersGuide.tex', | |
| 'Python Developer\'s Guide Documentation', | |
| 'Brett Cannon', | |
| '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 | |
| # Additional stuff for the LaTeX preamble. | |
| #latex_preamble = '' | |
| # 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 = [ | |
| ( | |
| 'index', | |
| 'pythondevelopersguide', | |
| "Python Developer's Guide Documentation", | |
| ['Brett Cannon'], | |
| 1, | |
| ), | |
| ] | |
| # ignore linkcheck anchors for /#/$ANCHOR since it is used for | |
| # dynamic pages such as http://buildbot.python.org/all/#/console | |
| # http://www.sphinx-doc.org/en/stable/config.html?highlight=linkcheck#confval-linkcheck_anchors_ignore | |
| linkcheck_anchors_ignore = [ | |
| # match any anchor that starts with a '/' since this is an invalid HTML anchor | |
| '\/.*', | |
| ] | |
| # Use our custom CSS stylesheet to differentiate us from the official python | |
| # docs. | |
| def setup(app): | |
| app.add_css_file('custom.css') |