|
24 | 24 | # -- General configuration ------------------------------------------------ |
25 | 25 |
|
26 | 26 | # If your documentation needs a minimal Sphinx version, state it here. |
27 | | -#needs_sphinx = '1.0' |
| 27 | +# needs_sphinx = '1.0' |
28 | 28 |
|
29 | 29 | # Add any Sphinx extension module names here, as strings. They can be |
30 | 30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
47 | 47 | source_suffix = '.rst' |
48 | 48 |
|
49 | 49 | # The encoding of source files. |
50 | | -#source_encoding = 'utf-8-sig' |
| 50 | +# source_encoding = 'utf-8-sig' |
51 | 51 |
|
52 | 52 | # The master toctree document. |
53 | 53 | master_doc = 'index' |
|
75 | 75 |
|
76 | 76 | # There are two options for replacing |today|: either, you set today to some |
77 | 77 | # non-false value, then it is used: |
78 | | -#today = '' |
| 78 | +# today = '' |
79 | 79 | # Else, today_fmt is used as the format for a strftime call. |
80 | | -#today_fmt = '%B %d, %Y' |
| 80 | +# today_fmt = '%B %d, %Y' |
81 | 81 |
|
82 | 82 | # List of patterns, relative to source directory, that match files and |
83 | 83 | # directories to ignore when looking for source files. |
|
86 | 86 |
|
87 | 87 | # The reST default role (used for this markup: `text`) to use for all |
88 | 88 | # documents. |
89 | | -#default_role = None |
| 89 | +# default_role = None |
90 | 90 |
|
91 | 91 | # If true, '()' will be appended to :func: etc. cross-reference text. |
92 | 92 | add_function_parentheses = True |
|
97 | 97 |
|
98 | 98 | # If true, sectionauthor and moduleauthor directives will be shown in the |
99 | 99 | # output. They are ignored by default. |
100 | | -#show_authors = False |
| 100 | +# show_authors = False |
101 | 101 |
|
102 | 102 | # The name of the Pygments (syntax highlighting) style to use. |
103 | 103 | pygments_style = 'sphinx' |
104 | 104 |
|
105 | 105 | # A list of ignored prefixes for module index sorting. |
106 | | -#modindex_common_prefix = [] |
| 106 | +# modindex_common_prefix = [] |
107 | 107 |
|
108 | 108 | # If true, keep warnings as "system message" paragraphs in the built documents. |
109 | | -#keep_warnings = False |
| 109 | +# keep_warnings = False |
110 | 110 |
|
111 | 111 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
112 | 112 | todo_include_todos = True |
113 | 113 |
|
114 | | - |
115 | 114 | # -- Options for HTML output ---------------------------------------------- |
116 | 115 |
|
117 | 116 | # The theme to use for HTML and HTML Help pages. See the documentation for |
118 | 117 | # a list of builtin themes. |
119 | | -#html_theme = 'default' |
| 118 | +# html_theme = 'default' |
120 | 119 | html_theme = 'sphinx_rtd_theme' |
121 | 120 |
|
122 | 121 | # Theme options are theme-specific and customize the look and feel of a theme |
123 | 122 | # further. For a list of options available for each theme, see the |
124 | 123 | # documentation. |
125 | | -#html_theme_options = {} |
| 124 | +# html_theme_options = {} |
126 | 125 |
|
127 | 126 | # Add any paths that contain custom themes here, relative to this directory. |
128 | | -#html_theme_path = [] |
| 127 | +# html_theme_path = [] |
129 | 128 |
|
130 | 129 | # The name for this set of Sphinx documents. |
131 | 130 | # "<project> v<release> documentation" by default. |
132 | | -#html_title = 'crocodile v0.1' |
| 131 | +# html_title = 'crocodile v0.1' |
133 | 132 |
|
134 | 133 | # A shorter title for the navigation bar. Default is the same as html_title. |
135 | | -#html_short_title = None |
| 134 | +# html_short_title = None |
136 | 135 |
|
137 | 136 | # The name of an image file (relative to this directory) to place at the top |
138 | 137 | # of the sidebar. |
139 | | -#html_logo = None |
| 138 | +# html_logo = None |
140 | 139 |
|
141 | 140 | # The name of an image file (relative to this directory) to use as a favicon of |
142 | 141 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
143 | 142 | # pixels large. |
144 | | -#html_favicon = None |
| 143 | +# html_favicon = None |
145 | 144 |
|
146 | 145 | # Add any paths that contain custom static files (such as style sheets) here, |
147 | 146 | # relative to this directory. They are copied after the builtin static files, |
|
151 | 150 | # Add any extra paths that contain custom files (such as robots.txt or |
152 | 151 | # .htaccess) here, relative to this directory. These files are copied |
153 | 152 | # directly to the root of the documentation. |
154 | | -#html_extra_path = [] |
| 153 | +# html_extra_path = [] |
155 | 154 |
|
156 | 155 | # If not None, a 'Last updated on:' timestamp is inserted at every page |
157 | 156 | # bottom, using the given strftime format. |
|
160 | 159 |
|
161 | 160 | # If true, SmartyPants will be used to convert quotes and dashes to |
162 | 161 | # typographically correct entities. |
163 | | -#html_use_smartypants = True |
| 162 | +# html_use_smartypants = True |
164 | 163 |
|
165 | 164 | # Custom sidebar templates, maps document names to template names. |
166 | | -#html_sidebars = {} |
| 165 | +# html_sidebars = {} |
167 | 166 |
|
168 | 167 | # Additional templates that should be rendered to pages, maps page names to |
169 | 168 | # template names. |
170 | | -#html_additional_pages = {} |
| 169 | +# html_additional_pages = {} |
171 | 170 |
|
172 | 171 | # If false, no module index is generated. |
173 | 172 | html_domain_indices = True |
|
176 | 175 | html_use_index = True |
177 | 176 |
|
178 | 177 | # If true, the index is split into individual pages for each letter. |
179 | | -#html_split_index = False |
| 178 | +# html_split_index = False |
180 | 179 |
|
181 | 180 | # If true, links to the reST sources are added to the pages. |
182 | | -#html_show_sourcelink = True |
| 181 | +# html_show_sourcelink = True |
183 | 182 |
|
184 | 183 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
185 | | -#html_show_sphinx = True |
| 184 | +# html_show_sphinx = True |
186 | 185 |
|
187 | 186 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
188 | | -#html_show_copyright = True |
| 187 | +# html_show_copyright = True |
189 | 188 |
|
190 | 189 | # If true, an OpenSearch description file will be output, and all pages will |
191 | 190 | # contain a <link> tag referring to it. The value of this option must be the |
192 | 191 | # base URL from which the finished HTML is served. |
193 | | -#html_use_opensearch = '' |
| 192 | +# html_use_opensearch = '' |
194 | 193 |
|
195 | 194 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
196 | | -#html_file_suffix = None |
| 195 | +# html_file_suffix = None |
197 | 196 |
|
198 | 197 | # Language to be used for generating the HTML full-text search index. |
199 | 198 | # Sphinx supports the following languages: |
200 | 199 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' |
201 | 200 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' |
202 | | -#html_search_language = 'en' |
| 201 | +# html_search_language = 'en' |
203 | 202 |
|
204 | 203 | # A dictionary with options for the search language support, empty by default. |
205 | 204 | # 'ja' uses this config value. |
206 | 205 | # 'zh' user can custom change `jieba` dictionary path. |
207 | | -#html_search_options = {'type': 'default'} |
| 206 | +# html_search_options = {'type': 'default'} |
208 | 207 |
|
209 | 208 | # The name of a javascript file (relative to the configuration directory) that |
210 | 209 | # implements a search results scorer. If empty, the default will be used. |
211 | | -#html_search_scorer = 'scorer.js' |
| 210 | +# html_search_scorer = 'scorer.js' |
212 | 211 |
|
213 | 212 | # Output file base name for HTML help builder. |
214 | 213 | htmlhelp_basename = 'arldoc' |
215 | 214 |
|
216 | 215 | # -- Options for LaTeX output --------------------------------------------- |
217 | 216 |
|
218 | 217 | latex_elements = { |
219 | | -# The paper size ('letterpaper' or 'a4paper'). |
220 | | -#'papersize': 'letterpaper', |
221 | | - |
222 | | -# The font size ('10pt', '11pt' or '12pt'). |
223 | | -#'pointsize': '10pt', |
224 | | - |
225 | | -# Additional stuff for the LaTeX preamble. |
226 | | -#'preamble': '', |
227 | | - |
228 | | -# Latex figure (float) alignment |
229 | | -#'figure_align': 'htbp', |
| 218 | + # The paper size ('letterpaper' or 'a4paper'). |
| 219 | + # 'papersize': 'letterpaper', |
| 220 | + |
| 221 | + # The font size ('10pt', '11pt' or '12pt'). |
| 222 | + # 'pointsize': '10pt', |
| 223 | + |
| 224 | + # Additional stuff for the LaTeX preamble. |
| 225 | + # 'preamble': '', |
| 226 | + |
| 227 | + # Latex figure (float) alignment |
| 228 | + # 'figure_align': 'htbp', |
230 | 229 | } |
231 | 230 |
|
232 | 231 | # Grouping the document tree into LaTeX files. List of tuples |
|
239 | 238 |
|
240 | 239 | # The name of an image file (relative to this directory) to place at the top of |
241 | 240 | # the title page. |
242 | | -#latex_logo = None |
| 241 | +# latex_logo = None |
243 | 242 |
|
244 | 243 | # For "manual" documents, if this is true, then toplevel headings are parts, |
245 | 244 | # not chapters. |
246 | | -#latex_use_parts = False |
| 245 | +# latex_use_parts = False |
247 | 246 |
|
248 | 247 | # If true, show page references after internal links. |
249 | | -#latex_show_pagerefs = False |
| 248 | +# latex_show_pagerefs = False |
250 | 249 |
|
251 | 250 | # If true, show URL addresses after external links. |
252 | | -#latex_show_urls = False |
| 251 | +# latex_show_urls = False |
253 | 252 |
|
254 | 253 | # Documents to append as an appendix to all manuals. |
255 | | -#latex_appendices = [] |
| 254 | +# latex_appendices = [] |
256 | 255 |
|
257 | 256 | # If false, no module index is generated. |
258 | | -#latex_domain_indices = True |
| 257 | +# latex_domain_indices = True |
259 | 258 |
|
260 | 259 |
|
261 | 260 | # -- Options for manual page output --------------------------------------- |
|
268 | 267 | ] |
269 | 268 |
|
270 | 269 | # If true, show URL addresses after external links. |
271 | | -#man_show_urls = False |
| 270 | +# man_show_urls = False |
272 | 271 |
|
273 | 272 |
|
274 | 273 | # -- Options for Texinfo output ------------------------------------------- |
|
283 | 282 | ] |
284 | 283 |
|
285 | 284 | # Documents to append as an appendix to all manuals. |
286 | | -#texinfo_appendices = [] |
| 285 | +# texinfo_appendices = [] |
287 | 286 |
|
288 | 287 | # If false, no module index is generated. |
289 | | -#texinfo_domain_indices = True |
| 288 | +# texinfo_domain_indices = True |
290 | 289 |
|
291 | 290 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
292 | | -#texinfo_show_urls = 'footnote' |
| 291 | +# texinfo_show_urls = 'footnote' |
293 | 292 |
|
294 | 293 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
295 | | -#texinfo_no_detailmenu = False |
296 | | - |
| 294 | +# texinfo_no_detailmenu = False |
0 commit comments