blob: 38364867532054342520e622a8a3d1fd213d7c20 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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 %}
|
