Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
peps/conf.py /
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This file is placed in the public domain or under the | |
| # CC0-1.0-Universal license, whichever is more permissive. | |
| """Configuration for building PEPs using Sphinx.""" | |
| from pathlib import Path | |
| import sys | |
| sys.path.append(str(Path("pep_sphinx_extensions").absolute())) | |
| # -- Project information ----------------------------------------------------- | |
| project = "PEPs" | |
| master_doc = "contents" | |
| # -- General configuration --------------------------------------------------- | |
| # Add any Sphinx extension module names here, as strings. | |
| extensions = [ | |
| "pep_sphinx_extensions", | |
| "sphinx.ext.intersphinx", | |
| "sphinx.ext.githubpages", | |
| ] | |
| # The file extensions of source files. Sphinx uses these suffixes as sources. | |
| source_suffix = { | |
| ".rst": "pep", | |
| ".txt": "pep", | |
| } | |
| # List of patterns (relative to source dir) to ignore when looking for source files. | |
| include_patterns = [ | |
| # Required for Sphinx | |
| "contents.rst", | |
| # PEP files | |
| "pep-????.rst", | |
| "pep-????.txt", | |
| # PEP ancillary files | |
| "pep-????/*.rst", | |
| # Documentation | |
| "docs/*.rst", | |
| ] | |
| exclude_patterns = [ | |
| # PEP Template | |
| "pep-0012/pep-NNNN.rst", | |
| ] | |
| # Intersphinx configuration | |
| intersphinx_mapping = { | |
| 'python': ('https://docs.python.org/3/', None), | |
| 'packaging': ('https://packaging.python.org/en/latest/', None), | |
| } | |
| intersphinx_disabled_reftypes = [] | |
| # -- Options for HTML output ------------------------------------------------- | |
| # HTML output settings | |
| html_math_renderer = "maths_to_html" # Maths rendering | |
| # Theme settings | |
| html_theme_path = ["pep_sphinx_extensions"] | |
| html_theme = "pep_theme" # The actual theme directory (child of html_theme_path) | |
| html_use_index = False # Disable index (we use PEP 0) | |
| html_style = "" # must be defined here or in theme.conf, but is unused | |
| html_permalinks = False # handled in the PEPContents transform | |
| html_baseurl = "https://peps.python.org" # to create the CNAME file | |
| gettext_auto_build = False # speed-ups | |
| templates_path = ["pep_sphinx_extensions/pep_theme/templates"] # Theme template relative paths from `confdir` |