conf.py - Sphinx configuration for generating CodeChat’s documentation¶

This file configures Sphinx, which transforms restructured text (reST) into html. See Sphinx build configuration file docs for more information on the settings below.

This file was originally created by sphinx-quickstart, then modified by hand. Notes on its operation:

This file is execfile()d by Sphinx with the current directory set to its containing dir.
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.

Use the CodeChat version date in its generated documentation.

import CodeChat.CodeToRestSphinx

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, as shown here.

##sys.path.insert(0, os.path.abspath('.'))

Project information ¶

project and copyright: General information about the project. Change this for your project.

project = "CodeChat"
copyright = "2022, Bryan A. Jones"
 

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. Change these for your project.

version: The short X.Y version.

version = CodeChat.__version__

release: The full version, including alpha/beta/rc tags.

release = version
 

There are two options for replacing |today|:

1. If you set today to some non-false value, then it is used:

##today = ''

2. Otherwise, today_fmt is used as the format for a strftime call.

##today_fmt = '%B %d, %Y'

highlight_language: The default language to highlight source code in.

highlight_language = "python3"
 

pygments_style: The style name to use for Pygments highlighting of source code.

pygments_style = "sphinx"
 

add_function_parentheses: If true, ‘()’ will be appended to :func: etc. cross-reference text.

##add_function_parentheses = True

add_module_names: If true, the current module name will be prepended to all description unit titles (such as .. function::).

##add_module_names = True

show_authors: If true, sectionauthor and moduleauthor directives will be shown in the output. They are ignored by default.

##show_authors = False

modindex_common_prefix: A list of ignored prefixes for module index sorting.

##modindex_common_prefix = []

General configuration ¶

extensions: If your documentation needs a minimal Sphinx version, state it here.

##needs_sphinx = '1.5'

Add any Sphinx extension module names here, as strings. They can be extensions coming with Sphinx (named ‘sphinx.ext.*’) or your custom ones. CodeChat note: The CodeChat.CodeToRestSphinx extension is mandatory; without it, CodeChat will not translate source code to reST and then (via Sphinx) to html.

extensions = [
    "CodeChat.CodeToRestSphinx",
    "sphinx.ext.graphviz",
    "sphinx.ext.intersphinx",
    "myst_parser",
]
 

templates_path: Add any paths that contain templates here, relative to this directory.

##templates_path = []

rst_epilog: A string of reStructuredText that will be included at the end of every source file that is read.

rst_epilog = (

Provide a convenient way to refer to a source file’s name. See _docname_role.

    """

.. |docname| replace:: :docname:`name`
"""
)
 

source_suffix: The suffix of source filenames. Add .in and .spec files (see below).

source_suffix = ".rst"
 

CodeChat note: CodeChat_lexer_for_glob: a dict of {glob, lexer_alias}, which uses lexer_alias (e.g. a lexer’s short name) to analyze any file which matches the given glob-style pattern (e.g. a glob).

CodeChat_lexer_for_glob = {

CSS files are auto-detected as a CSS + Lasso file by Pygments, causing it to display incorrectly. Define them as CSS only.

    "*.css": "CSS",

These files use # as a comment. So does Perl. Ugly, no?

    "MANIFEST.in": "Perl",
    ".gitignore": "Perl",

Misc.

    ".flake8": "INI",
}
 

source_encoding: The encoding of source files.

##source_encoding = 'utf-8-sig'

master_doc: The master toctree document.

master_doc = "index"
 

language: The language for content autogenerated by Sphinx. Refer to documentation for a list of supported languages.

##language = None

exclude_patterns: List of patterns, relative to source directory, that match files and directories to ignore when looking for source files.

exclude_patterns = [

Ignore setup.py output.

    "build",
    "dist",

Ignore Sphinx output.

    "_build",
    "CodeChat/sphinx_template/_build",

Test files

    "test/*.html",

Misc files.

    ".pytest_cache",
    "__pycache__",
    "Thumbs.db",
    ".DS_Store",
    ".vscode",
    ".venv",
]
 

default_role: The reST default role (used for this markup: `text`) to use for all documents.

default_role = "any"
 

keep_warnings: If true, keep warnings as “system message” paragraphs in the built documents. Regardless of this setting, warnings are always written to the standard error stream when sphinx-build is run. CodeChat note: This should always be True; doing so places warnings next to the offending text in the web view, making them easy to find and fix.

keep_warnings = True

Options for HTML output ¶

html_theme: The theme to use for HTML and HTML Help pages.

html_theme = "alabaster"
 

html_theme_options: Theme options are theme-specific and customize the look and feel of a theme further.

##html_theme_options = {}

html_style: The style sheet to use for HTML pages.

##html_style = None

html_theme_path: Add any paths that contain custom themes here, relative to this directory.

##html_theme_path = []

html_title: The name for this set of Sphinx documents. If None, it defaults to <project> v<release> documentation.

##html_title = None

html_short_title: A shorter title for the navigation bar. Default is the same as html_title.

##html_short_title = None

html_logo: The name of an image file (relative to this directory) to place at the top of the sidebar.

##html_logo = None

html_favicon: 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

html_static_path: Add any paths that contain custom static files (such as style sheets) here, relative to this directory. They are copied after the builtin static files, so a file named default.css will overwrite the builtin default.css. CodeChat note: Include the path to CodeChat’s static files.

html_static_path = CodeChat.CodeToRest.html_static_path()
 

html_last_updated_fmt: 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"
 

html_sidebars: Custom sidebar templates, maps document names to template names. Set this per the Alabaster theme customizations.

 
html_sidebars = {
    "**": [
        "about.html",
        "navigation.html",
        "relations.html",
        "searchbox.html",
        "donate.html",
    ]
}
 

html_additional_pages: Additional templates that should be rendered to pages, maps page names to template names.

##html_additional_pages = {}

html_domain_indices: If false, no module index is generated.

##html_domain_indices = True

html_use_index: If false, no index is generated.

html_use_index = False
 

html_split_index: If true, the index is split into individual pages for each letter.

##html_split_index = False

html_copy_source: If true, the reST sources are included in the HTML build as _sources/name.

html_copy_source = True
 

html_show_sourcelink: If true, links to the reST sources are added to the pages.

html_show_sourcelink = True
 

html_sourcelink_suffix: Suffix to be appended to source links (see html_show_sourcelink), unless they have this suffix already.

html_sourcelink_suffix = ""
 

html_show_sphinx: If true, “Created using Sphinx” is shown in the HTML footer. Default is True.

##html_show_sphinx = True

html_show_copyright: If true, “(C) Copyright …” is shown in the HTML footer. Default is True.

##html_show_copyright = True

html_use_opensearch: 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 = ''

html_file_suffix: This is the file name suffix for HTML files (e.g. “.xhtml”).

##html_file_suffix = None

Intersphinx¶

intersphinx_mapping: This config value contains the locations and names of other projects that should be linked to in this documentation.

intersphinx_mapping = {
    "CodeChat_System": (
        "https://codechat-system.readthedocs.io/en/latest/",
        (
            None,

An optional local file location – useful when updating both Sphinx builds before the updates are pushed to the server.

            "../CodeChat_system/_build/objects.inv",
        ),
    )
}
 
 

Options for Graphviz output ¶

The output format for Graphviz when building HTML files.

graphviz_output_format = "svg"

###########################################################################

auto-created readthedocs.org specific configuration #

###########################################################################

The following code was added during an automated build on readthedocs.org It is auto created and injected for every build. The result is based on the conf.py.tmpl file found in the readthedocs.org codebase: https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

Note: this file shouldn’t rely on extra dependencies.

 
import importlib
import sys
import os.path
 

Borrowed from six.

PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

from sphinx import version_info
 

Get suffix for proper linking to GitHub This is deprecated in Sphinx 1.3+, as each page can have its own suffix

if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):

Sphinx >= 1.3 supports list/tuple to define multiple suffixes

        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):

Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes

        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:

default to .rst

        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'
 

Add RTD Static Path. Add to the end because it overwrites previous files.

if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')
 

Define this variable in case it’s not defined by the user. It defaults to alabaster which is the default from Sphinx. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme

html_theme = globals().get('html_theme', 'alabaster')

#Add project information to the template context.
context = {
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'STATIC_URL': "https://assets.readthedocs.org/static/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'proxied_static_path': "/_/static/",
    'versions': [
    ("master", "/en/master/"),
    ("latest", "/en/latest/"),
    ],
    'downloads': [
    ],
    'subprojects': [
    ],
    'slug': 'codechat',
    'name': u'CodeChat',
    'rtd_language': u'en',
    'programming_language': u'py',
    'canonical_url': '',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/',
    'api_host': 'https://readthedocs.org',
    'github_user': 'bjones1',
    'proxied_api_host': '/_',
    'github_repo': 'CodeChat',
    'github_version': 'master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',
    'commit': 'eeff5825',
}
 

For sphinx >=1.8 we can use html_baseurl to set the canonical URL. https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl

if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





if 'html_context' in globals():
    for key in context:
        if key not in html_context:
            html_context[key] = context[key]
else:
    html_context = context
 

Add custom RTD extension

if 'extensions' in globals():

Insert at the beginning because it can interfere with other extensions. See https://github.com/rtfd/readthedocs.org/pull/4054

    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]
 

Add External version warning banner to the external version documentation

if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.org/projects/codechat/builds/22495271/'

project_language = 'en'
 

User’s Sphinx configurations

language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)
 

Remove this once xindy gets installed in Docker image and XINDYOPS env variable is supported https://github.com/rtfd/readthedocs-docker-images/pull/98

latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'
 

Make sure our build directory is always excluded

exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])

conf.py - Sphinx configuration for generating CodeChat’s documentation¶

Project information ¶

General configuration ¶

Options for HTML output ¶

Intersphinx¶

Options for Graphviz output ¶

CodeChat

Navigation

Related Topics

conf.py - Sphinx configuration for generating CodeChat’s documentation¶

Project information¶

General configuration¶

Options for HTML output¶

Intersphinx¶

Options for Graphviz output¶

Project information ¶

General configuration ¶

Options for HTML output ¶

Options for Graphviz output ¶