|
13 | 13 | # All configuration values have a default; values that are commented out |
14 | 14 | # serve to show the default. |
15 | 15 |
|
16 | | -import sys |
17 | | -import os |
18 | | - |
19 | 16 | # If extensions (or modules to document with autodoc) are in another directory, |
20 | 17 | # add these directories to sys.path here. If the directory is relative to the |
21 | 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
22 | | -#sys.path.insert(0, os.path.abspath('.')) |
| 19 | +# sys.path.insert(0, os.path.abspath('.')) |
23 | 20 |
|
24 | 21 | # -- General configuration ------------------------------------------------ |
25 | 22 |
|
|
56 | 53 | source_suffix = '.rst' |
57 | 54 |
|
58 | 55 | # The encoding of source files. |
59 | | -#source_encoding = 'utf-8-sig' |
| 56 | +# source_encoding = 'utf-8-sig' |
60 | 57 |
|
61 | 58 | # The master toctree document. |
62 | 59 | master_doc = 'index' |
|
76 | 73 |
|
77 | 74 | # The language for content autogenerated by Sphinx. Refer to documentation |
78 | 75 | # for a list of supported languages. |
79 | | -#language = None |
| 76 | +# language = None |
80 | 77 |
|
81 | 78 | # There are two options for replacing |today|: either, you set today to some |
82 | 79 | # non-false value, then it is used: |
83 | | -#today = '' |
| 80 | +# today = '' |
84 | 81 | # Else, today_fmt is used as the format for a strftime call. |
85 | | -#today_fmt = '%B %d, %Y' |
| 82 | +# today_fmt = '%B %d, %Y' |
86 | 83 |
|
87 | 84 | # List of patterns, relative to source directory, that match files and |
88 | 85 | # directories to ignore when looking for source files. |
|
93 | 90 | default_role = 'obj' |
94 | 91 |
|
95 | 92 | # If true, '()' will be appended to :func: etc. cross-reference text. |
96 | | -#add_function_parentheses = True |
| 93 | +# add_function_parentheses = True |
97 | 94 |
|
98 | 95 | # If true, the current module name will be prepended to all description |
99 | 96 | # unit titles (such as .. function::). |
100 | | -#add_module_names = True |
| 97 | +# add_module_names = True |
101 | 98 |
|
102 | 99 | # If true, sectionauthor and moduleauthor directives will be shown in the |
103 | 100 | # output. They are ignored by default. |
104 | | -#show_authors = False |
| 101 | +# show_authors = False |
105 | 102 |
|
106 | 103 | # The name of the Pygments (syntax highlighting) style to use. |
107 | 104 | pygments_style = 'sphinx' |
108 | 105 |
|
109 | 106 | # A list of ignored prefixes for module index sorting. |
110 | | -#modindex_common_prefix = [] |
| 107 | +# modindex_common_prefix = [] |
111 | 108 |
|
112 | 109 | # If true, keep warnings as "system message" paragraphs in the built documents. |
113 | | -#keep_warnings = False |
| 110 | +# keep_warnings = False |
114 | 111 |
|
115 | 112 |
|
116 | 113 | # -- Options for HTML output ---------------------------------------------- |
|
122 | 119 | # Theme options are theme-specific and customize the look and feel of a theme |
123 | 120 | # further. For a list of options available for each theme, see the |
124 | 121 | # documentation. |
125 | | -#html_theme_options = {} |
| 122 | +# html_theme_options = {} |
126 | 123 |
|
127 | 124 | # Add any paths that contain custom themes here, relative to this directory. |
128 | | -#html_theme_path = [] |
| 125 | +# html_theme_path = [] |
129 | 126 |
|
130 | 127 | # The name for this set of Sphinx documents. If None, it defaults to |
131 | 128 | # "<project> v<release> documentation". |
132 | | -#html_title = None |
| 129 | +# html_title = None |
133 | 130 |
|
134 | 131 | # A shorter title for the navigation bar. Default is the same as html_title. |
135 | | -#html_short_title = None |
| 132 | +# html_short_title = None |
136 | 133 |
|
137 | 134 | # The name of an image file (relative to this directory) to place at the top |
138 | 135 | # of the sidebar. |
139 | | -#html_logo = None |
| 136 | +# html_logo = None |
140 | 137 |
|
141 | 138 | # The name of an image file (within the static path) to use as favicon of the |
142 | 139 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
143 | 140 | # pixels large. |
144 | | -#html_favicon = None |
| 141 | +# html_favicon = None |
145 | 142 |
|
146 | 143 | # Add any paths that contain custom static files (such as style sheets) here, |
147 | 144 | # relative to this directory. They are copied after the builtin static files, |
|
151 | 148 | # Add any extra paths that contain custom files (such as robots.txt or |
152 | 149 | # .htaccess) here, relative to this directory. These files are copied |
153 | 150 | # directly to the root of the documentation. |
154 | | -#html_extra_path = [] |
| 151 | +# html_extra_path = [] |
155 | 152 |
|
156 | 153 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
157 | 154 | # using the given strftime format. |
158 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 155 | +# html_last_updated_fmt = '%b %d, %Y' |
159 | 156 |
|
160 | 157 | # If true, SmartyPants will be used to convert quotes and dashes to |
161 | 158 | # typographically correct entities. |
162 | | -#html_use_smartypants = True |
| 159 | +# html_use_smartypants = True |
163 | 160 |
|
164 | 161 | # Custom sidebar templates, maps document names to template names. |
165 | | -#html_sidebars = {} |
| 162 | +# html_sidebars = {} |
166 | 163 |
|
167 | 164 | # Additional templates that should be rendered to pages, maps page names to |
168 | 165 | # template names. |
169 | | -#html_additional_pages = {} |
| 166 | +# html_additional_pages = {} |
170 | 167 |
|
171 | 168 | # If false, no module index is generated. |
172 | | -#html_domain_indices = True |
| 169 | +# html_domain_indices = True |
173 | 170 |
|
174 | 171 | # If false, no index is generated. |
175 | | -#html_use_index = True |
| 172 | +# html_use_index = True |
176 | 173 |
|
177 | 174 | # If true, the index is split into individual pages for each letter. |
178 | | -#html_split_index = False |
| 175 | +# html_split_index = False |
179 | 176 |
|
180 | 177 | # If true, links to the reST sources are added to the pages. |
181 | | -#html_show_sourcelink = True |
| 178 | +# html_show_sourcelink = True |
182 | 179 |
|
183 | 180 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
184 | | -#html_show_sphinx = True |
| 181 | +# html_show_sphinx = True |
185 | 182 |
|
186 | 183 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
187 | | -#html_show_copyright = True |
| 184 | +# html_show_copyright = True |
188 | 185 |
|
189 | 186 | # If true, an OpenSearch description file will be output, and all pages will |
190 | 187 | # contain a <link> tag referring to it. The value of this option must be the |
191 | 188 | # base URL from which the finished HTML is served. |
192 | | -#html_use_opensearch = '' |
| 189 | +# html_use_opensearch = '' |
193 | 190 |
|
194 | 191 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
195 | | -#html_file_suffix = None |
| 192 | +# html_file_suffix = None |
196 | 193 |
|
197 | 194 | # Output file base name for HTML help builder. |
198 | 195 | htmlhelp_basename = 'cyclerdoc' |
|
201 | 198 | # -- Options for LaTeX output --------------------------------------------- |
202 | 199 |
|
203 | 200 | latex_elements = { |
204 | | -# The paper size ('letterpaper' or 'a4paper'). |
205 | | -#'papersize': 'letterpaper', |
| 201 | + # The paper size ('letterpaper' or 'a4paper'). |
| 202 | + # 'papersize': 'letterpaper', |
206 | 203 |
|
207 | | -# The font size ('10pt', '11pt' or '12pt'). |
208 | | -#'pointsize': '10pt', |
| 204 | + # The font size ('10pt', '11pt' or '12pt'). |
| 205 | + # 'pointsize': '10pt', |
209 | 206 |
|
210 | | -# Additional stuff for the LaTeX preamble. |
211 | | -#'preamble': '', |
| 207 | + # Additional stuff for the LaTeX preamble. |
| 208 | + # 'preamble': '', |
212 | 209 | } |
213 | 210 |
|
214 | 211 | # Grouping the document tree into LaTeX files. List of tuples |
|
221 | 218 |
|
222 | 219 | # The name of an image file (relative to this directory) to place at the top of |
223 | 220 | # the title page. |
224 | | -#latex_logo = None |
| 221 | +# latex_logo = None |
225 | 222 |
|
226 | 223 | # For "manual" documents, if this is true, then toplevel headings are parts, |
227 | 224 | # not chapters. |
228 | | -#latex_use_parts = False |
| 225 | +# latex_use_parts = False |
229 | 226 |
|
230 | 227 | # If true, show page references after internal links. |
231 | | -#latex_show_pagerefs = False |
| 228 | +# latex_show_pagerefs = False |
232 | 229 |
|
233 | 230 | # If true, show URL addresses after external links. |
234 | | -#latex_show_urls = False |
| 231 | +# latex_show_urls = False |
235 | 232 |
|
236 | 233 | # Documents to append as an appendix to all manuals. |
237 | | -#latex_appendices = [] |
| 234 | +# latex_appendices = [] |
238 | 235 |
|
239 | 236 | # If false, no module index is generated. |
240 | | -#latex_domain_indices = True |
| 237 | +# latex_domain_indices = True |
241 | 238 |
|
242 | 239 |
|
243 | 240 | # -- Options for manual page output --------------------------------------- |
|
250 | 247 | ] |
251 | 248 |
|
252 | 249 | # If true, show URL addresses after external links. |
253 | | -#man_show_urls = False |
| 250 | +# man_show_urls = False |
254 | 251 |
|
255 | 252 |
|
256 | 253 | # -- Options for Texinfo output ------------------------------------------- |
|
265 | 262 | ] |
266 | 263 |
|
267 | 264 | # Documents to append as an appendix to all manuals. |
268 | | -#texinfo_appendices = [] |
| 265 | +# texinfo_appendices = [] |
269 | 266 |
|
270 | 267 | # If false, no module index is generated. |
271 | | -#texinfo_domain_indices = True |
| 268 | +# texinfo_domain_indices = True |
272 | 269 |
|
273 | 270 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
274 | | -#texinfo_show_urls = 'footnote' |
| 271 | +# texinfo_show_urls = 'footnote' |
275 | 272 |
|
276 | 273 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
277 | | -#texinfo_no_detailmenu = False |
| 274 | +# texinfo_no_detailmenu = False |
278 | 275 |
|
279 | 276 | intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None), |
280 | 277 | 'matplotlb': ('https://matplotlib.org', None)} |
281 | 278 |
|
282 | | -################# numpydoc config #################### |
| 279 | +# ################ numpydoc config #################### |
283 | 280 | numpydoc_show_class_members = False |
0 commit comments