|
11 | 11 | #
|
12 | 12 | # All configuration values have a default; values that are commented out
|
13 | 13 | # serve to show the default.
|
14 |
| - |
15 |
| -import sys |
16 | 14 | import os
|
| 15 | +import sys |
17 | 16 |
|
18 | 17 | # If extensions (or modules to document with autodoc) are in another directory,
|
19 | 18 | # add these directories to sys.path here. If the directory is relative to the
|
20 | 19 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
21 |
| -#sys.path.insert(0, os.path.abspath('.')) |
| 20 | +# sys.path.insert(0, os.path.abspath('.')) |
22 | 21 | sys.path.insert(0, os.path.abspath('..'))
|
23 | 22 |
|
24 | 23 | # -- General configuration ----------------------------------------------------
|
25 | 24 |
|
26 | 25 | # If your documentation needs a minimal Sphinx version, state it here.
|
27 |
| -#needs_sphinx = '1.0' |
| 26 | +# needs_sphinx = '1.0' |
28 | 27 |
|
29 | 28 | # Add any Sphinx extension module names here, as strings. They can be
|
30 | 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
38 | 37 | source_suffix = '.rst'
|
39 | 38 |
|
40 | 39 | # The encoding of source files.
|
41 |
| -#source_encoding = 'utf-8-sig' |
| 40 | +# source_encoding = 'utf-8-sig' |
42 | 41 |
|
43 | 42 | # The master toctree document.
|
44 | 43 | master_doc = 'index'
|
|
61 | 60 |
|
62 | 61 | # The language for content autogenerated by Sphinx. Refer to documentation
|
63 | 62 | # for a list of supported languages.
|
64 |
| -#language = None |
| 63 | +# language = None |
65 | 64 |
|
66 | 65 | # There are two options for replacing |today|: either, you set today to some
|
67 | 66 | # non-false value, then it is used:
|
68 |
| -#today = '' |
| 67 | +# today = '' |
69 | 68 | # Else, today_fmt is used as the format for a strftime call.
|
70 |
| -#today_fmt = '%B %d, %Y' |
| 69 | +# today_fmt = '%B %d, %Y' |
71 | 70 |
|
72 | 71 | # List of patterns, relative to source directory, that match files and
|
73 | 72 | # directories to ignore when looking for source files.
|
74 | 73 | exclude_patterns = ['_build']
|
75 | 74 |
|
76 | 75 | # The reST default role (used for this markup: `text`) to use for
|
77 | 76 | # all documents.
|
78 |
| -#default_role = None |
| 77 | +# default_role = None |
79 | 78 |
|
80 | 79 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
81 |
| -#add_function_parentheses = True |
| 80 | +# add_function_parentheses = True |
82 | 81 |
|
83 | 82 | # If true, the current module name will be prepended to all description
|
84 | 83 | # unit titles (such as .. function::).
|
85 |
| -#add_module_names = True |
| 84 | +# add_module_names = True |
86 | 85 |
|
87 | 86 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
88 | 87 | # output. They are ignored by default.
|
89 |
| -#show_authors = False |
| 88 | +# show_authors = False |
90 | 89 |
|
91 | 90 | # The name of the Pygments (syntax highlighting) style to use.
|
92 | 91 | pygments_style = 'sphinx'
|
93 | 92 |
|
94 | 93 | # A list of ignored prefixes for module index sorting.
|
95 |
| -#modindex_common_prefix = [] |
| 94 | +# modindex_common_prefix = [] |
96 | 95 |
|
97 | 96 |
|
98 | 97 | # -- Options for HTML output --------------------------------------------------
|
|
108 | 107 | # Theme options are theme-specific and customize the look and feel of a theme
|
109 | 108 | # further. For a list of options available for each theme, see the
|
110 | 109 | # documentation.
|
111 |
| -#html_theme_options = {} |
| 110 | +# html_theme_options = {} |
112 | 111 |
|
113 | 112 | # Add any paths that contain custom themes here, relative to this directory.
|
114 |
| -#html_theme_path = [] |
| 113 | +# html_theme_path = [] |
115 | 114 |
|
116 | 115 | # The name for this set of Sphinx documents. If None, it defaults to
|
117 | 116 | # "<project> v<release> documentation".
|
118 |
| -#html_title = None |
| 117 | +# html_title = None |
119 | 118 |
|
120 | 119 | # A shorter title for the navigation bar. Default is the same as html_title.
|
121 |
| -#html_short_title = None |
| 120 | +# html_short_title = None |
122 | 121 |
|
123 | 122 | # The name of an image file (relative to this directory) to place at the top
|
124 | 123 | # of the sidebar.
|
125 |
| -#html_logo = None |
| 124 | +# html_logo = None |
126 | 125 |
|
127 | 126 | # The name of an image file (within the static path) to use as favicon of the
|
128 | 127 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
129 | 128 | # pixels large.
|
130 |
| -#html_favicon = None |
| 129 | +# html_favicon = None |
131 | 130 |
|
132 | 131 | # Add any paths that contain custom static files (such as style sheets) here,
|
133 | 132 | # relative to this directory. They are copied after the builtin static files,
|
|
136 | 135 |
|
137 | 136 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
138 | 137 | # using the given strftime format.
|
139 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 138 | +# html_last_updated_fmt = '%b %d, %Y' |
140 | 139 |
|
141 | 140 | # If true, SmartyPants will be used to convert quotes and dashes to
|
142 | 141 | # typographically correct entities.
|
143 |
| -#html_use_smartypants = True |
| 142 | +# html_use_smartypants = True |
144 | 143 |
|
145 | 144 | # Custom sidebar templates, maps document names to template names.
|
146 |
| -#html_sidebars = {} |
| 145 | +# html_sidebars = {} |
147 | 146 |
|
148 | 147 | # Additional templates that should be rendered to pages, maps page names to
|
149 | 148 | # template names.
|
150 |
| -#html_additional_pages = {} |
| 149 | +# html_additional_pages = {} |
151 | 150 |
|
152 | 151 | # If false, no module index is generated.
|
153 |
| -#html_domain_indices = True |
| 152 | +# html_domain_indices = True |
154 | 153 |
|
155 | 154 | # If false, no index is generated.
|
156 |
| -#html_use_index = True |
| 155 | +# html_use_index = True |
157 | 156 |
|
158 | 157 | # If true, the index is split into individual pages for each letter.
|
159 |
| -#html_split_index = False |
| 158 | +# html_split_index = False |
160 | 159 |
|
161 | 160 | # If true, links to the reST sources are added to the pages.
|
162 |
| -#html_show_sourcelink = True |
| 161 | +# html_show_sourcelink = True |
163 | 162 |
|
164 | 163 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
165 |
| -#html_show_sphinx = True |
| 164 | +# html_show_sphinx = True |
166 | 165 |
|
167 | 166 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
168 |
| -#html_show_copyright = True |
| 167 | +# html_show_copyright = True |
169 | 168 |
|
170 | 169 | # If true, an OpenSearch description file will be output, and all pages will
|
171 | 170 | # contain a <link> tag referring to it. The value of this option must be the
|
172 | 171 | # base URL from which the finished HTML is served.
|
173 |
| -#html_use_opensearch = '' |
| 172 | +# html_use_opensearch = '' |
174 | 173 |
|
175 | 174 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
176 |
| -#html_file_suffix = None |
| 175 | +# html_file_suffix = None |
177 | 176 |
|
178 | 177 | # Output file base name for HTML help builder.
|
179 | 178 | htmlhelp_basename = 'pycodestyledoc'
|
|
183 | 182 |
|
184 | 183 | latex_elements = {
|
185 | 184 | # The paper size ('letterpaper' or 'a4paper').
|
186 |
| - #'papersize': 'letterpaper', |
| 185 | + # 'papersize': 'letterpaper', |
187 | 186 |
|
188 | 187 | # The font size ('10pt', '11pt' or '12pt').
|
189 |
| - #'pointsize': '10pt', |
| 188 | + # 'pointsize': '10pt', |
190 | 189 |
|
191 | 190 | # Additional stuff for the LaTeX preamble.
|
192 |
| - #'preamble': '', |
| 191 | + # 'preamble': '', |
193 | 192 | }
|
194 | 193 |
|
195 | 194 | # Grouping the document tree into LaTeX files. List of tuples
|
|
202 | 201 |
|
203 | 202 | # The name of an image file (relative to this directory) to place at the top of
|
204 | 203 | # the title page.
|
205 |
| -#latex_logo = None |
| 204 | +# latex_logo = None |
206 | 205 |
|
207 | 206 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
208 | 207 | # not chapters.
|
209 |
| -#latex_use_parts = False |
| 208 | +# latex_use_parts = False |
210 | 209 |
|
211 | 210 | # If true, show page references after internal links.
|
212 |
| -#latex_show_pagerefs = False |
| 211 | +# latex_show_pagerefs = False |
213 | 212 |
|
214 | 213 | # If true, show URL addresses after external links.
|
215 |
| -#latex_show_urls = False |
| 214 | +# latex_show_urls = False |
216 | 215 |
|
217 | 216 | # Documents to append as an appendix to all manuals.
|
218 |
| -#latex_appendices = [] |
| 217 | +# latex_appendices = [] |
219 | 218 |
|
220 | 219 | # If false, no module index is generated.
|
221 |
| -#latex_domain_indices = True |
| 220 | +# latex_domain_indices = True |
222 | 221 |
|
223 | 222 |
|
224 | 223 | # -- Options for manual page output -------------------------------------------
|
|
231 | 230 | ]
|
232 | 231 |
|
233 | 232 | # If true, show URL addresses after external links.
|
234 |
| -#man_show_urls = False |
| 233 | +# man_show_urls = False |
235 | 234 |
|
236 | 235 |
|
237 | 236 | # -- Options for Texinfo output -----------------------------------------------
|
|
246 | 245 | ]
|
247 | 246 |
|
248 | 247 | # Documents to append as an appendix to all manuals.
|
249 |
| -#texinfo_appendices = [] |
| 248 | +# texinfo_appendices = [] |
250 | 249 |
|
251 | 250 | # If false, no module index is generated.
|
252 |
| -#texinfo_domain_indices = True |
| 251 | +# texinfo_domain_indices = True |
253 | 252 |
|
254 | 253 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
255 |
| -#texinfo_show_urls = 'footnote' |
| 254 | +# texinfo_show_urls = 'footnote' |
0 commit comments