diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:25:40 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:25:40 +0000 |
commit | cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a (patch) | |
tree | 18dcde1a8d1f5570a77cd0c361de3b490d02c789 /sphinx/templates/quickstart/conf.py_t | |
parent | Initial commit. (diff) | |
download | sphinx-upstream.tar.xz sphinx-upstream.zip |
Adding upstream version 7.2.6.upstream/7.2.6upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'sphinx/templates/quickstart/conf.py_t')
-rw-r--r-- | sphinx/templates/quickstart/conf.py_t | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/sphinx/templates/quickstart/conf.py_t b/sphinx/templates/quickstart/conf.py_t new file mode 100644 index 0000000..3836486 --- /dev/null +++ b/sphinx/templates/quickstart/conf.py_t @@ -0,0 +1,71 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +{% if append_syspath -%} +# -- Path setup -------------------------------------------------------------- + +import os +import sys +sys.path.insert(0, {{ module_path | repr }}) + +{% endif -%} +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = {{ project | repr }} +copyright = {{ copyright | repr }} +author = {{ author | repr }} + +{%- if version %} + +version = {{ version | repr }} +{%- endif %} +{%- if release %} +release = {{ release | repr }} +{%- endif %} + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [{% if extensions %} +{%- for ext in extensions %} + '{{ ext }}', +{%- endfor %} +{% endif %}] + +templates_path = ['{{ dot }}templates'] +exclude_patterns = [{{ exclude_patterns }}] + +{% if suffix != '.rst' -%} +source_suffix = {{ suffix | repr }} +{% endif -%} + +{% if root_doc != 'index' -%} +root_doc = {{ root_doc | repr }} +{% endif -%} + +{% if language -%} +language = {{ language | repr }} +{%- endif %} + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['{{ dot }}static'] +{% if 'sphinx.ext.intersphinx' in extensions %} +# -- Options for intersphinx extension --------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), +} +{% endif -%} +{% if 'sphinx.ext.todo' in extensions %} +# -- Options for todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration + +todo_include_todos = True +{% endif %} |