conf.py - The CodeChat System documentation configuration¶
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.
Contents¶
The following files also configure the documentation.
Imports¶
Ensure the path to these docs available in order to import the version number.
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.
Project information¶
project and copyright: General information about the project. Change this for your project.
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.
release: The full version, including alpha/beta/rc tags.
There are two options for replacing |today|
:
1. If you set today to some non-false value, then it is used:
2. Otherwise, today_fmt is used as the format for a strftime call.
highlight_language: The default language to highlight source code in.
pygments_style: The style name to use for Pygments highlighting of source code.
add_function_parentheses:
If true, ‘()’ will be appended to :func:
etc. cross-reference text.
add_module_names:
If true, the current module name will be prepended to all description unit
titles (such as .. function::
).
show_authors: If
true, sectionauthor
and moduleauthor
directives will be shown in the
output. They are ignored by default.
modindex_common_prefix: A list of ignored prefixes for module index sorting.
General configuration¶
extensions: If your documentation needs a minimal Sphinx version, state it here.
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.
templates_path: Add any paths that contain templates here, relative to this directory.
rst_epilog: A string of reStructuredText that will be included at the end of every source file that is read.
|docname|
substitution¶
Provide a convenient way to refer to a source file’s name.
A commonly-used link.
source_suffix: The suffix of source filenames.
CodeChat note: CodeChat_lexer_for_glob is 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. glob.
CSS files are auto-detected as a CSS + Lasso file by Pygments, causing it to display incorrectly. Define them as CSS only.
These files use # as a comment. So does Perl. Ugly, no?
Treat JavaScript as plain JavaScript; the auto-detect code finds something else.
The coverage config files is INI.
Misc.
source_encoding: The encoding of source files.
master_doc: The master toctree document.
language: The language for content autogenerated by Sphinx. Refer to documentation for a list of supported languages.
exclude_patterns: List of patterns, relative to source directory, that match files and directories to ignore when looking for source files.
Misc files.
Sphinx build output
JavaScript/TypeScript generated files
Files generated by packaging.
Libraries
Misc
IntelliJ branch
default_role: The
reST default role (used for this markup: `text`
) to use for all documents.
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.
Options for HTML output¶
html_theme: The theme to use for HTML and HTML Help pages.
html_theme_options: Theme options are theme-specific and customize the look and feel of a theme further.
html_style: The style sheet to use for HTML pages.
html_theme_path: Add any paths that contain custom themes here, relative to this directory.
html_title: The
name for this set of Sphinx documents. If None, it defaults to <project>
v<release> documentation
.
html_short_title: A shorter title for the navigation bar. Default is the same as html_title.
html_logo: The name of an image file (relative to this directory) to place at the top of the sidebar.
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_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_last_updated_fmt: If not ‘’, a ‘Last updated on:’ timestamp is inserted at every page bottom, using the given strftime format.
html_sidebars: Custom sidebar templates, maps document names to template names.
html_additional_pages: Additional templates that should be rendered to pages, maps page names to template names.
html_domain_indices: If false, no module index is generated.
html_use_index: If false, no index is generated.
html_split_index: If true, the index is split into individual pages for each letter.
html_copy_source: If true, the reST sources are included in the HTML build as _sources/name.
html_show_sourcelink: If true, links to the reST sources are added to the pages.
html_sourcelink_suffix: Suffix to be appended to source links (see html_show_sourcelink), unless they have this suffix already.
html_show_sphinx: If true, “Created using Sphinx” is shown in the HTML footer. Default is True.
html_show_copyright: If true, “(C) Copyright …” is shown in the HTML footer. Default is 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_file_suffix: This is the file name suffix for HTML files (e.g. “.xhtml”).
Intersphinx¶
intersphinx_mapping: This config value contains the locations and names of other projects that should be linked to in this documentation.
An optional local file location – useful when updating both Sphinx builds before the updates are pushed to the server.
Options for Graphviz output¶
The output format for Graphviz when building HTML files.
Given the name of a template to build, do so.
def build_template(template_name):
cmd = [
"CodeChat_Server",
"build",
f"CodeChat_Server/CodeChat_Server/templates/{template_name}",
]
cmd_str = " ".join(cmd)
logger.info(f"Running {cmd_str}...")
try:
cp = subprocess.run(
cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True
)
except subprocess.CalledProcessError as e:
logger.error(f"Build of {template_name} template failed:\n{e.output}")
except FileNotFoundError as e:
logger.error(f"{e} when executing {cmd_str}.")
else:
print(cp.stdout)
def build_template_projects(app):
Determine if we’re running an RTD build.
In the following calls, include a specific file to build, so the CodeChat Server can build only if they are out of date.
ReadTheDocs doesn’t have these installed.
A good idea from Breathe.
return the usual extension metadata.
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.
Borrowed from six.
Get suffix for proper linking to GitHub This is deprecated in Sphinx 1.3+, as each page can have its own suffix
Sphinx >= 1.3 supports list/tuple to define multiple suffixes
Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
default to .rst
Add RTD Static Path. Add to the end because it overwrites previous files.
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': [
("latest", "/en/latest/"),
],
'downloads': [
],
'subprojects': [
],
'slug': 'codechat-system',
'name': u'The CodeChat System',
'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_system',
'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': '87dadfe2',
}
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
Add custom RTD extension
Insert at the beginning because it can interfere with other extensions. See https://github.com/rtfd/readthedocs.org/pull/4054
Add External version warning banner to the external version documentation
User’s Sphinx configurations
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