Show More
@@ -1,311 +1,311 b'' | |||||
1 | # -*- coding: utf-8 -*- |
|
1 | ||
2 | # |
|
2 | # | |
3 | # RhodeCode Enterprise documentation build configuration file, created by |
|
3 | # RhodeCode Enterprise documentation build configuration file, created by | |
4 | # sphinx-quickstart on Tue Nov 4 11:48:37 2014. |
|
4 | # sphinx-quickstart on Tue Nov 4 11:48:37 2014. | |
5 | # |
|
5 | # | |
6 | # This file is execfile()d with the current directory set to its |
|
6 | # This file is execfile()d with the current directory set to its | |
7 | # containing dir. |
|
7 | # containing dir. | |
8 | # |
|
8 | # | |
9 | # Note that not all possible configuration values are present in this |
|
9 | # Note that not all possible configuration values are present in this | |
10 | # autogenerated file. |
|
10 | # autogenerated file. | |
11 | # |
|
11 | # | |
12 | # All configuration values have a default; values that are commented out |
|
12 | # All configuration values have a default; values that are commented out | |
13 | # serve to show the default. |
|
13 | # serve to show the default. | |
14 |
|
14 | |||
15 | import sys |
|
15 | import sys | |
16 | import os |
|
16 | import os | |
17 | import datetime |
|
17 | import datetime | |
18 | import sphinx_rtd_theme |
|
18 | import sphinx_rtd_theme | |
19 |
|
19 | |||
20 | # If extensions (or modules to document with autodoc) are in another directory, |
|
20 | # If extensions (or modules to document with autodoc) are in another directory, | |
21 | # add these directories to sys.path here. If the directory is relative to the |
|
21 | # add these directories to sys.path here. If the directory is relative to the | |
22 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
|
22 | # documentation root, use os.path.abspath to make it absolute, like shown here. | |
23 | sys.path.insert(0, os.path.abspath('.')) |
|
23 | sys.path.insert(0, os.path.abspath('.')) | |
24 | import common |
|
24 | import common | |
25 |
|
25 | |||
26 | # -- General configuration ------------------------------------------------ |
|
26 | # -- General configuration ------------------------------------------------ | |
27 |
|
27 | |||
28 | # If your documentation needs a minimal Sphinx version, state it here. |
|
28 | # If your documentation needs a minimal Sphinx version, state it here. | |
29 | #needs_sphinx = '1.0' |
|
29 | #needs_sphinx = '1.0' | |
30 |
|
30 | |||
31 | # Add any Sphinx extension module names here, as strings. They can be |
|
31 | # Add any Sphinx extension module names here, as strings. They can be | |
32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |
33 | # ones. |
|
33 | # ones. | |
34 | extensions = [ |
|
34 | extensions = [ | |
35 | 'sphinx.ext.autodoc', |
|
35 | 'sphinx.ext.autodoc', | |
36 | 'sphinx.ext.intersphinx', |
|
36 | 'sphinx.ext.intersphinx', | |
37 | 'sphinx.ext.todo', |
|
37 | 'sphinx.ext.todo', | |
38 | 'sphinx.ext.imgmath' |
|
38 | 'sphinx.ext.imgmath' | |
39 | ] |
|
39 | ] | |
40 |
|
40 | |||
41 | intersphinx_mapping = { |
|
41 | intersphinx_mapping = { | |
42 | 'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None), |
|
42 | 'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None), | |
43 | 'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None), |
|
43 | 'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None), | |
44 | } |
|
44 | } | |
45 |
|
45 | |||
46 | # Add any paths that contain templates here, relative to this directory. |
|
46 | # Add any paths that contain templates here, relative to this directory. | |
47 | templates_path = ['_templates'] |
|
47 | templates_path = ['_templates'] | |
48 |
|
48 | |||
49 | # The suffix of source filenames. |
|
49 | # The suffix of source filenames. | |
50 | source_suffix = '.rst' |
|
50 | source_suffix = '.rst' | |
51 |
|
51 | |||
52 | # The encoding of source files. |
|
52 | # The encoding of source files. | |
53 | #source_encoding = 'utf-8-sig' |
|
53 | #source_encoding = 'utf-8-sig' | |
54 |
|
54 | |||
55 | # The master toctree document. |
|
55 | # The master toctree document. | |
56 | master_doc = 'index' |
|
56 | master_doc = 'index' | |
57 |
|
57 | |||
58 | # The version info for the project you're documenting, acts as replacement for |
|
58 | # The version info for the project you're documenting, acts as replacement for | |
59 | # |version| and |release|, also used in various other places throughout the |
|
59 | # |version| and |release|, also used in various other places throughout the | |
60 | # built documents. |
|
60 | # built documents. | |
61 |
|
61 | |||
62 |
|
62 | |||
63 | def _get_version(): |
|
63 | def _get_version(): | |
64 | with open('../rhodecode/VERSION') as f: |
|
64 | with open('../rhodecode/VERSION') as f: | |
65 | return f.read().strip() |
|
65 | return f.read().strip() | |
66 |
|
66 | |||
67 |
|
67 | |||
68 | # The full version, including alpha/beta/rc tags. |
|
68 | # The full version, including alpha/beta/rc tags. | |
69 | release = _get_version() |
|
69 | release = _get_version() | |
70 | # The short X.Y version. |
|
70 | # The short X.Y version. | |
71 | version = '.'.join(release.split('.', 2)[:2]) # First two parts of release |
|
71 | version = '.'.join(release.split('.', 2)[:2]) # First two parts of release | |
72 |
|
72 | |||
73 | # General information about the project. |
|
73 | # General information about the project. | |
74 | project = u'RhodeCode Enterprise %s ' % _get_version() |
|
74 | project = u'RhodeCode Enterprise %s ' % _get_version() | |
75 | copyright = u'2010-{now.year}, RhodeCode GmbH'.format( |
|
75 | copyright = u'2010-{now.year}, RhodeCode GmbH'.format( | |
76 | now=datetime.datetime.today()) |
|
76 | now=datetime.datetime.today()) | |
77 |
|
77 | |||
78 |
|
78 | |||
79 | # The language for content autogenerated by Sphinx. Refer to documentation |
|
79 | # The language for content autogenerated by Sphinx. Refer to documentation | |
80 | # for a list of supported languages. |
|
80 | # for a list of supported languages. | |
81 | #language = None |
|
81 | #language = None | |
82 |
|
82 | |||
83 | rst_epilog = common.rst_epilog + """ |
|
83 | rst_epilog = common.rst_epilog + """ | |
84 | .. |async| replace:: asynchronous |
|
84 | .. |async| replace:: asynchronous | |
85 | """ |
|
85 | """ | |
86 |
|
86 | |||
87 | # There are two options for replacing |today|: either, you set today to some |
|
87 | # There are two options for replacing |today|: either, you set today to some | |
88 | # non-false value, then it is used: |
|
88 | # non-false value, then it is used: | |
89 | #today = '' |
|
89 | #today = '' | |
90 | # Else, today_fmt is used as the format for a strftime call. |
|
90 | # Else, today_fmt is used as the format for a strftime call. | |
91 | #today_fmt = '%B %d, %Y' |
|
91 | #today_fmt = '%B %d, %Y' | |
92 |
|
92 | |||
93 | # List of patterns, relative to source directory, that match files and |
|
93 | # List of patterns, relative to source directory, that match files and | |
94 | # directories to ignore when looking for source files. |
|
94 | # directories to ignore when looking for source files. | |
95 | exclude_patterns = [ |
|
95 | exclude_patterns = [ | |
96 | # Special directories |
|
96 | # Special directories | |
97 | '_build', |
|
97 | '_build', | |
98 | 'result', |
|
98 | 'result', | |
99 |
|
99 | |||
100 | # Other RST files |
|
100 | # Other RST files | |
101 | 'admin/rhodecode-backup.rst', |
|
101 | 'admin/rhodecode-backup.rst', | |
102 | 'issue-trackers/redmine.rst', |
|
102 | 'issue-trackers/redmine.rst', | |
103 | 'known-issues/error-msg-guide.rst', |
|
103 | 'known-issues/error-msg-guide.rst', | |
104 | 'tutorials/docs-build.rst', |
|
104 | 'tutorials/docs-build.rst', | |
105 | 'integrations/example-ext.py', |
|
105 | 'integrations/example-ext.py', | |
106 | 'collaboration/supported-workflows.rst', |
|
106 | 'collaboration/supported-workflows.rst', | |
107 | ] |
|
107 | ] | |
108 |
|
108 | |||
109 |
|
109 | |||
110 | # The reST default role (used for this markup: `text`) to use for all |
|
110 | # The reST default role (used for this markup: `text`) to use for all | |
111 | # documents. |
|
111 | # documents. | |
112 | #default_role = None |
|
112 | #default_role = None | |
113 |
|
113 | |||
114 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
114 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
115 | #add_function_parentheses = True |
|
115 | #add_function_parentheses = True | |
116 |
|
116 | |||
117 | # If true, the current module name will be prepended to all description |
|
117 | # If true, the current module name will be prepended to all description | |
118 | # unit titles (such as .. function::). |
|
118 | # unit titles (such as .. function::). | |
119 | #add_module_names = True |
|
119 | #add_module_names = True | |
120 |
|
120 | |||
121 | # If true, sectionauthor and moduleauthor directives will be shown in the |
|
121 | # If true, sectionauthor and moduleauthor directives will be shown in the | |
122 | # output. They are ignored by default. |
|
122 | # output. They are ignored by default. | |
123 | #show_authors = False |
|
123 | #show_authors = False | |
124 |
|
124 | |||
125 | # The name of the Pygments (syntax highlighting) style to use. |
|
125 | # The name of the Pygments (syntax highlighting) style to use. | |
126 | pygments_style = 'sphinx' |
|
126 | pygments_style = 'sphinx' | |
127 |
|
127 | |||
128 | # A list of ignored prefixes for module index sorting. |
|
128 | # A list of ignored prefixes for module index sorting. | |
129 | #modindex_common_prefix = [] |
|
129 | #modindex_common_prefix = [] | |
130 |
|
130 | |||
131 | # If true, keep warnings as "system message" paragraphs in the built documents. |
|
131 | # If true, keep warnings as "system message" paragraphs in the built documents. | |
132 | keep_warnings = tags.has("dev") |
|
132 | keep_warnings = tags.has("dev") | |
133 |
|
133 | |||
134 |
|
134 | |||
135 | # -- Options for HTML output ---------------------------------------------- |
|
135 | # -- Options for HTML output ---------------------------------------------- | |
136 |
|
136 | |||
137 | # The theme to use for HTML and HTML Help pages. See the documentation for |
|
137 | # The theme to use for HTML and HTML Help pages. See the documentation for | |
138 | # a list of builtin themes. |
|
138 | # a list of builtin themes. | |
139 | #html_theme = 'rctheme' |
|
139 | #html_theme = 'rctheme' | |
140 | html_theme = 'sphinx_rtd_theme' |
|
140 | html_theme = 'sphinx_rtd_theme' | |
141 |
|
141 | |||
142 | # Theme options are theme-specific and customize the look and feel of a theme |
|
142 | # Theme options are theme-specific and customize the look and feel of a theme | |
143 | # further. For a list of options available for each theme, see the |
|
143 | # further. For a list of options available for each theme, see the | |
144 | # documentation. |
|
144 | # documentation. | |
145 | #html_theme_options = {} |
|
145 | #html_theme_options = {} | |
146 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
|
146 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | |
147 |
|
147 | |||
148 | # Add any paths that contain custom themes here, relative to this directory. |
|
148 | # Add any paths that contain custom themes here, relative to this directory. | |
149 | #html_theme_path = [] |
|
149 | #html_theme_path = [] | |
150 |
|
150 | |||
151 | # The name for this set of Sphinx documents. If None, it defaults to |
|
151 | # The name for this set of Sphinx documents. If None, it defaults to | |
152 | # "<project> v<release> documentation". |
|
152 | # "<project> v<release> documentation". | |
153 | #html_title = None |
|
153 | #html_title = None | |
154 |
|
154 | |||
155 | # A shorter title for the navigation bar. Default is the same as html_title. |
|
155 | # A shorter title for the navigation bar. Default is the same as html_title. | |
156 | #html_short_title = None |
|
156 | #html_short_title = None | |
157 |
|
157 | |||
158 | # The name of an image file (relative to this directory) to place at the top |
|
158 | # The name of an image file (relative to this directory) to place at the top | |
159 | # of the sidebar. |
|
159 | # of the sidebar. | |
160 | #html_logo = None |
|
160 | #html_logo = None | |
161 | html_sidebars = { |
|
161 | html_sidebars = { | |
162 | '**': ['globaltoc.html'], |
|
162 | '**': ['globaltoc.html'], | |
163 | } |
|
163 | } | |
164 |
|
164 | |||
165 | # The name of an image file (within the static path) to use as favicon of the |
|
165 | # The name of an image file (within the static path) to use as favicon of the | |
166 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
|
166 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |
167 | # pixels large. |
|
167 | # pixels large. | |
168 | html_favicon = 'images/favicon.ico' |
|
168 | html_favicon = 'images/favicon.ico' | |
169 |
|
169 | |||
170 | # Add any paths that contain custom static files (such as style sheets) here, |
|
170 | # Add any paths that contain custom static files (such as style sheets) here, | |
171 | # relative to this directory. They are copied after the builtin static files, |
|
171 | # relative to this directory. They are copied after the builtin static files, | |
172 | # so a file named "default.css" will overwrite the builtin "default.css". |
|
172 | # so a file named "default.css" will overwrite the builtin "default.css". | |
173 | html_static_path = ['static/css/add.css'] |
|
173 | html_static_path = ['static/css/add.css'] | |
174 |
|
174 | |||
175 | # Add any extra paths that contain custom files (such as robots.txt or |
|
175 | # Add any extra paths that contain custom files (such as robots.txt or | |
176 | # .htaccess) here, relative to this directory. These files are copied |
|
176 | # .htaccess) here, relative to this directory. These files are copied | |
177 | # directly to the root of the documentation. |
|
177 | # directly to the root of the documentation. | |
178 | #html_extra_path = [] |
|
178 | #html_extra_path = [] | |
179 |
|
179 | |||
180 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
|
180 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
181 | # using the given strftime format. |
|
181 | # using the given strftime format. | |
182 | #html_last_updated_fmt = '%b %d, %Y' |
|
182 | #html_last_updated_fmt = '%b %d, %Y' | |
183 |
|
183 | |||
184 | # If true, SmartyPants will be used to convert quotes and dashes to |
|
184 | # If true, SmartyPants will be used to convert quotes and dashes to | |
185 | # typographically correct entities. |
|
185 | # typographically correct entities. | |
186 | #html_use_smartypants = True |
|
186 | #html_use_smartypants = True | |
187 |
|
187 | |||
188 | # Custom sidebar templates, maps document names to template names. |
|
188 | # Custom sidebar templates, maps document names to template names. | |
189 | #html_sidebars = {} |
|
189 | #html_sidebars = {} | |
190 |
|
190 | |||
191 | # Additional templates that should be rendered to pages, maps page names to |
|
191 | # Additional templates that should be rendered to pages, maps page names to | |
192 | # template names. |
|
192 | # template names. | |
193 | #html_additional_pages = {} |
|
193 | #html_additional_pages = {} | |
194 |
|
194 | |||
195 | # If false, no module index is generated. |
|
195 | # If false, no module index is generated. | |
196 | #html_domain_indices = True |
|
196 | #html_domain_indices = True | |
197 |
|
197 | |||
198 | # If false, no index is generated. |
|
198 | # If false, no index is generated. | |
199 | #html_use_index = True |
|
199 | #html_use_index = True | |
200 |
|
200 | |||
201 | # If true, the index is split into individual pages for each letter. |
|
201 | # If true, the index is split into individual pages for each letter. | |
202 | #html_split_index = False |
|
202 | #html_split_index = False | |
203 |
|
203 | |||
204 | # If true, links to the reST sources are added to the pages. |
|
204 | # If true, links to the reST sources are added to the pages. | |
205 | #html_show_sourcelink = True |
|
205 | #html_show_sourcelink = True | |
206 |
|
206 | |||
207 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
|
207 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |
208 | #html_show_sphinx = True |
|
208 | #html_show_sphinx = True | |
209 |
|
209 | |||
210 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
|
210 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |
211 | #html_show_copyright = True |
|
211 | #html_show_copyright = True | |
212 |
|
212 | |||
213 | # If true, an OpenSearch description file will be output, and all pages will |
|
213 | # If true, an OpenSearch description file will be output, and all pages will | |
214 | # contain a <link> tag referring to it. The value of this option must be the |
|
214 | # contain a <link> tag referring to it. The value of this option must be the | |
215 | # base URL from which the finished HTML is served. |
|
215 | # base URL from which the finished HTML is served. | |
216 | #html_use_opensearch = '' |
|
216 | #html_use_opensearch = '' | |
217 |
|
217 | |||
218 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
|
218 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |
219 | #html_file_suffix = None |
|
219 | #html_file_suffix = None | |
220 |
|
220 | |||
221 | # Output file base name for HTML help builder. |
|
221 | # Output file base name for HTML help builder. | |
222 | htmlhelp_basename = 'rhodecode-enterprise' |
|
222 | htmlhelp_basename = 'rhodecode-enterprise' | |
223 |
|
223 | |||
224 |
|
224 | |||
225 | # -- Options for LaTeX output --------------------------------------------- |
|
225 | # -- Options for LaTeX output --------------------------------------------- | |
226 |
|
226 | |||
227 | latex_elements = { |
|
227 | latex_elements = { | |
228 | 'classoptions': ',oneside', |
|
228 | 'classoptions': ',oneside', | |
229 | 'babel': '\\usepackage[english]{babel}', |
|
229 | 'babel': '\\usepackage[english]{babel}', | |
230 |
|
230 | |||
231 | # The paper size ('letterpaper' or 'a4paper'). |
|
231 | # The paper size ('letterpaper' or 'a4paper'). | |
232 | #'papersize': 'letterpaper', |
|
232 | #'papersize': 'letterpaper', | |
233 |
|
233 | |||
234 | # The font size ('10pt', '11pt' or '12pt'). |
|
234 | # The font size ('10pt', '11pt' or '12pt'). | |
235 | #'pointsize': '10pt', |
|
235 | #'pointsize': '10pt', | |
236 |
|
236 | |||
237 | # Additional stuff for the LaTeX preamble. |
|
237 | # Additional stuff for the LaTeX preamble. | |
238 | #'preamble': '', |
|
238 | #'preamble': '', | |
239 | } |
|
239 | } | |
240 |
|
240 | |||
241 | # Grouping the document tree into LaTeX files. List of tuples |
|
241 | # Grouping the document tree into LaTeX files. List of tuples | |
242 | # (source start file, target name, title, |
|
242 | # (source start file, target name, title, | |
243 | # author, documentclass [howto, manual, or own class]). |
|
243 | # author, documentclass [howto, manual, or own class]). | |
244 | latex_documents = [ |
|
244 | latex_documents = [ | |
245 | ('index', 'RhodeCodeEnterprise.tex', u'RhodeCode Enterprise', |
|
245 | ('index', 'RhodeCodeEnterprise.tex', u'RhodeCode Enterprise', | |
246 | u'RhodeCode GmbH', 'manual'), |
|
246 | u'RhodeCode GmbH', 'manual'), | |
247 | ] |
|
247 | ] | |
248 |
|
248 | |||
249 | # The name of an image file (relative to this directory) to place at the top of |
|
249 | # The name of an image file (relative to this directory) to place at the top of | |
250 | # the title page. |
|
250 | # the title page. | |
251 | #latex_logo = None |
|
251 | #latex_logo = None | |
252 |
|
252 | |||
253 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|
253 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
254 | # not chapters. |
|
254 | # not chapters. | |
255 | #latex_use_parts = False |
|
255 | #latex_use_parts = False | |
256 |
|
256 | |||
257 | # If true, show page references after internal links. |
|
257 | # If true, show page references after internal links. | |
258 | latex_show_pagerefs = True |
|
258 | latex_show_pagerefs = True | |
259 |
|
259 | |||
260 | # If true, show URL addresses after external links. |
|
260 | # If true, show URL addresses after external links. | |
261 | latex_show_urls = 'footnote' |
|
261 | latex_show_urls = 'footnote' | |
262 |
|
262 | |||
263 | # Documents to append as an appendix to all manuals. |
|
263 | # Documents to append as an appendix to all manuals. | |
264 | #latex_appendices = [] |
|
264 | #latex_appendices = [] | |
265 |
|
265 | |||
266 | # If false, no module index is generated. |
|
266 | # If false, no module index is generated. | |
267 | #latex_domain_indices = True |
|
267 | #latex_domain_indices = True | |
268 |
|
268 | |||
269 | # Mode for literal blocks wider than the frame. Can be |
|
269 | # Mode for literal blocks wider than the frame. Can be | |
270 | # overflow, shrink or truncate |
|
270 | # overflow, shrink or truncate | |
271 | pdf_fit_mode = "truncate" |
|
271 | pdf_fit_mode = "truncate" | |
272 |
|
272 | |||
273 |
|
273 | |||
274 | # -- Options for manual page output --------------------------------------- |
|
274 | # -- Options for manual page output --------------------------------------- | |
275 |
|
275 | |||
276 | # One entry per manual page. List of tuples |
|
276 | # One entry per manual page. List of tuples | |
277 | # (source start file, name, description, authors, manual section). |
|
277 | # (source start file, name, description, authors, manual section). | |
278 | man_pages = [ |
|
278 | man_pages = [ | |
279 | ('index', 'rhodecodeenterprise', u'RhodeCode Enterprise', |
|
279 | ('index', 'rhodecodeenterprise', u'RhodeCode Enterprise', | |
280 | [u'RhodeCode GmbH'], 1) |
|
280 | [u'RhodeCode GmbH'], 1) | |
281 | ] |
|
281 | ] | |
282 |
|
282 | |||
283 | # If true, show URL addresses after external links. |
|
283 | # If true, show URL addresses after external links. | |
284 | #man_show_urls = False |
|
284 | #man_show_urls = False | |
285 |
|
285 | |||
286 |
|
286 | |||
287 | # -- Options for Texinfo output ------------------------------------------- |
|
287 | # -- Options for Texinfo output ------------------------------------------- | |
288 |
|
288 | |||
289 | # Grouping the document tree into Texinfo files. List of tuples |
|
289 | # Grouping the document tree into Texinfo files. List of tuples | |
290 | # (source start file, target name, title, author, |
|
290 | # (source start file, target name, title, author, | |
291 | # dir menu entry, description, category) |
|
291 | # dir menu entry, description, category) | |
292 | texinfo_documents = [ |
|
292 | texinfo_documents = [ | |
293 | ('index', 'RhodeCodeEnterprise', u'RhodeCode Enterprise', |
|
293 | ('index', 'RhodeCodeEnterprise', u'RhodeCode Enterprise', | |
294 | u'RhodeCode Docs Team', 'RhodeCodeEnterprise', 'RhodeCode Docs Project', |
|
294 | u'RhodeCode Docs Team', 'RhodeCodeEnterprise', 'RhodeCode Docs Project', | |
295 | 'Miscellaneous'), |
|
295 | 'Miscellaneous'), | |
296 | ] |
|
296 | ] | |
297 |
|
297 | |||
298 | # Documents to append as an appendix to all manuals. |
|
298 | # Documents to append as an appendix to all manuals. | |
299 | #texinfo_appendices = [] |
|
299 | #texinfo_appendices = [] | |
300 |
|
300 | |||
301 | # If false, no module index is generated. |
|
301 | # If false, no module index is generated. | |
302 | #texinfo_domain_indices = True |
|
302 | #texinfo_domain_indices = True | |
303 |
|
303 | |||
304 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
|
304 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | |
305 | #texinfo_show_urls = 'footnote' |
|
305 | #texinfo_show_urls = 'footnote' | |
306 |
|
306 | |||
307 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
|
307 | # If true, do not generate a @detailmenu in the "Top" node's menu. | |
308 | #texinfo_no_detailmenu = False |
|
308 | #texinfo_no_detailmenu = False | |
309 |
|
309 | |||
310 | # We want to see todo notes in case of a pre-release build of the documentation |
|
310 | # We want to see todo notes in case of a pre-release build of the documentation | |
311 | todo_include_todos = tags.has("dev") |
|
311 | todo_include_todos = tags.has("dev") |
General Comments 0
You need to be logged in to leave comments.
Login now