1
- # -*- coding: utf-8 -*-
2
- #
3
1
# Configuration file for the Sphinx documentation builder.
4
2
#
5
- # This file does only contain a selection of the most common options. For a
6
- # full list see the documentation:
3
+ # This file only contains a selection of the most common options. For a full
4
+ # list see the documentation:
7
5
# http://www.sphinx-doc.org/en/master/config
8
6
9
7
# -- Path setup --------------------------------------------------------------
15
13
{% if append_syspath -%}
16
14
import os
17
15
import sys
18
- sys.path.insert(0, u' {{ module_path }}' )
16
+ sys.path.insert(0, {{ module_path | repr }} )
19
17
{% else -%}
20
18
# import os
21
19
# import sys
22
20
{% if module_path -%}
23
- # sys.path.insert(0, u' {{ module_path }}' )
21
+ # sys.path.insert(0, {{ module_path | repr }} )
24
22
{% else -%}
25
23
# sys.path.insert(0, os.path.abspath('.'))
26
24
{% endif -%}
27
25
{% endif %}
28
26
29
27
# -- Project information -----------------------------------------------------
30
28
31
- project = u' {{ project_str }}'
32
- copyright = u' {{ copyright_str }}'
33
- author = u' {{ author_str }}'
29
+ project = {{ project | repr }}
30
+ copyright = {{ copyright | repr }}
31
+ author = {{ author | repr }}
34
32
35
33
# The short X.Y version
36
- version = u' {{ version_str }}'
34
+ version = {{ version | repr }}
37
35
# The full version, including alpha/beta/rc tags
38
- release = u' {{ release_str }}'
36
+ release = {{ release | repr }}
39
37
40
38
41
39
# -- General configuration ---------------------------------------------------
42
40
43
- # If your documentation needs a minimal Sphinx version, state it here.
44
- #
45
- # needs_sphinx = '1.0'
46
-
47
41
# Add any Sphinx extension module names here, as strings. They can be
48
42
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
49
43
# ones.
@@ -60,11 +54,11 @@ templates_path = ['{{ dot }}templates']
60
54
# You can specify multiple suffix as a list of string:
61
55
#
62
56
# source_suffix = ['.rst', '.md']
63
- source_suffix = ' {{ suffix }}'
57
+ source_suffix = {{ suffix | repr }}
64
58
65
59
{% if master_doc != 'index' -%}
66
60
# The master toctree document.
67
- master_doc = ' {{ master_str }}'
61
+ master_doc = {{ master | repr }}
68
62
69
63
{% endif -%}
70
64
# The language for content autogenerated by Sphinx. Refer to documentation
@@ -79,9 +73,6 @@ language = {{ language | repr }}
79
73
# This pattern also affects html_static_path and html_extra_path.
80
74
exclude_patterns = [{{ exclude_patterns }}]
81
75
82
- # The name of the Pygments (syntax highlighting) style to use.
83
- pygments_style = None
84
-
85
76
86
77
# -- Options for HTML output -------------------------------------------------
87
78
@@ -112,63 +103,6 @@ html_static_path = ['{{ dot }}static']
112
103
# html_sidebars = {}
113
104
114
105
115
- # -- Options for HTMLHelp output ---------------------------------------------
116
-
117
- # Output file base name for HTML help builder.
118
- htmlhelp_basename = '{{ project_fn }}doc'
119
-
120
-
121
- # -- Options for LaTeX output ------------------------------------------------
122
-
123
- latex_elements = {
124
- # The paper size ('letterpaper' or 'a4paper').
125
- #
126
- # 'papersize': 'letterpaper',
127
-
128
- # The font size ('10pt', '11pt' or '12pt').
129
- #
130
- # 'pointsize': '10pt',
131
-
132
- # Additional stuff for the LaTeX preamble.
133
- #
134
- # 'preamble': '',
135
-
136
- # Latex figure (float) alignment
137
- #
138
- # 'figure_align': 'htbp',
139
- }
140
-
141
- # Grouping the document tree into LaTeX files. List of tuples
142
- # (source start file, target name, title,
143
- # author, documentclass [howto, manual, or own class]).
144
- latex_documents = [
145
- (master_doc, '{{ project_fn }}.tex', u'{{ project_doc_texescaped_str }}',
146
- u'{{ author_texescaped_str }}', 'manual'),
147
- ]
148
-
149
-
150
- # -- Options for manual page output ------------------------------------------
151
-
152
- # One entry per manual page. List of tuples
153
- # (source start file, name, description, authors, manual section).
154
- man_pages = [
155
- (master_doc, '{{ project_manpage }}', u'{{ project_doc_str }}',
156
- [author], 1)
157
- ]
158
-
159
-
160
- # -- Options for Texinfo output ----------------------------------------------
161
-
162
- # Grouping the document tree into Texinfo files. List of tuples
163
- # (source start file, target name, title, author,
164
- # dir menu entry, description, category)
165
- texinfo_documents = [
166
- (master_doc, '{{ project_fn }}', u'{{ project_doc_str }}',
167
- author, '{{ project_fn }}', 'One line description of project.',
168
- 'Miscellaneous'),
169
- ]
170
-
171
-
172
106
# -- Options for Epub output -------------------------------------------------
173
107
174
108
# Bibliographic Dublin Core info.
@@ -204,3 +138,4 @@ intersphinx_mapping = {'https://docs.python.org/': None}
204
138
# If true, `todo` and `todoList` produce output, else they produce nothing.
205
139
todo_include_todos = True
206
140
{%- endif %}
141
+
0 commit comments