You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
117 lines
3.5 KiB
117 lines
3.5 KiB
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# 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.
|
|
#
|
|
{% if append_syspath -%}
|
|
import os
|
|
import sys
|
|
sys.path.insert(0, {{ module_path | repr }})
|
|
{% else -%}
|
|
# import os
|
|
# import sys
|
|
{% if module_path -%}
|
|
# sys.path.insert(0, {{ module_path | repr }})
|
|
{% else -%}
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
{% endif -%}
|
|
{% endif %}
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = {{ project | repr }}
|
|
copyright = {{ copyright | repr }}
|
|
author = {{ author | repr }}
|
|
|
|
{%- if version %}
|
|
|
|
# The short X.Y version
|
|
version = {{ version | repr }}
|
|
{%- endif %}
|
|
{%- if release %}
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = {{ release | repr }}
|
|
{%- endif %}
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
{%- for ext in extensions %}
|
|
'{{ ext }}',
|
|
{%- endfor %}
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['{{ dot }}templates']
|
|
|
|
{% if suffix != '.rst' -%}
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = {{ suffix | repr }}
|
|
|
|
{% endif -%}
|
|
{% if master != 'index' -%}
|
|
# The master toctree document.
|
|
master_doc = {{ master | repr }}
|
|
|
|
{% endif -%}
|
|
{% if language -%}
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = {{ language | repr }}
|
|
|
|
{% endif -%}
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = [{{ exclude_patterns }}]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'alabaster'
|
|
|
|
# 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".
|
|
html_static_path = ['{{ dot }}static']
|
|
{%- if extensions %}
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
{%- endif %}
|
|
{%- if 'sphinx.ext.intersphinx' in extensions %}
|
|
|
|
# -- Options for intersphinx extension ---------------------------------------
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {'https://docs.python.org/3/': None}
|
|
{%- endif %}
|
|
{%- if 'sphinx.ext.todo' in extensions %}
|
|
|
|
# -- Options for todo extension ----------------------------------------------
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = True
|
|
{%- endif %}
|