|
16 | 16 | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | 17 | # add these directories to sys.path here. If the directory is relative to the
|
18 | 18 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
19 |
| -#sys.path.insert(0, os.path.abspath('.')) |
| 19 | +# sys.path.insert(0, os.path.abspath('.')) |
20 | 20 |
|
21 | 21 | # -- General configuration ------------------------------------------------
|
22 | 22 |
|
23 | 23 | # If your documentation needs a minimal Sphinx version, state it here.
|
24 |
| -needs_sphinx = '1.3' |
| 24 | +needs_sphinx = "1.3" |
25 | 25 |
|
26 | 26 | # Add any Sphinx extension module names here, as strings. They can be
|
27 | 27 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
28 | 28 | # ones.
|
29 | 29 | extensions = [
|
30 |
| - 'sphinx.ext.autodoc', |
31 |
| - 'sphinx.ext.doctest', |
32 |
| - 'sphinx.ext.extlinks', |
33 |
| - 'sphinx.ext.intersphinx', |
34 |
| - 'sphinx.ext.todo', |
35 |
| - 'sphinx.ext.coverage', |
36 |
| - 'sphinx.ext.viewcode', |
37 |
| - 'sphinx-prompt', |
| 30 | + "sphinx.ext.autodoc", |
| 31 | + "sphinx.ext.doctest", |
| 32 | + "sphinx.ext.extlinks", |
| 33 | + "sphinx.ext.intersphinx", |
| 34 | + "sphinx.ext.todo", |
| 35 | + "sphinx.ext.coverage", |
| 36 | + "sphinx.ext.viewcode", |
| 37 | + "sphinx-prompt", |
38 | 38 | ]
|
39 | 39 |
|
40 | 40 | # Add any paths that contain templates here, relative to this directory.
|
41 |
| -templates_path = ['_templates'] |
| 41 | +templates_path = ["_templates"] |
42 | 42 |
|
43 | 43 | # The suffix(es) of source filenames.
|
44 | 44 | # You can specify multiple suffix as a list of string:
|
45 | 45 | # source_suffix = ['.rst', '.md']
|
46 |
| -source_suffix = '.rst' |
| 46 | +source_suffix = ".rst" |
47 | 47 |
|
48 | 48 | # The encoding of source files.
|
49 |
| -#source_encoding = 'utf-8-sig' |
| 49 | +# source_encoding = 'utf-8-sig' |
50 | 50 |
|
51 | 51 | # The master toctree document.
|
52 |
| -master_doc = 'index' |
| 52 | +master_doc = "index" |
53 | 53 |
|
54 | 54 | # General information about the project.
|
55 |
| -project = 'flake8' |
56 |
| -copyright = '2016, Ian Stapleton Cordasco' |
57 |
| -author = 'Ian Stapleton Cordasco' |
| 55 | +project = "flake8" |
| 56 | +copyright = "2016, Ian Stapleton Cordasco" |
| 57 | +author = "Ian Stapleton Cordasco" |
58 | 58 |
|
59 | 59 | import flake8
|
60 | 60 |
|
|
80 | 80 |
|
81 | 81 | # There are two options for replacing |today|: either, you set today to some
|
82 | 82 | # non-false value, then it is used:
|
83 |
| -#today = '' |
| 83 | +# today = '' |
84 | 84 | # Else, today_fmt is used as the format for a strftime call.
|
85 |
| -#today_fmt = '%B %d, %Y' |
| 85 | +# today_fmt = '%B %d, %Y' |
86 | 86 |
|
87 | 87 | # List of patterns, relative to source directory, that match files and
|
88 | 88 | # directories to ignore when looking for source files.
|
89 | 89 | exclude_patterns = []
|
90 | 90 |
|
91 | 91 | # The reST default role (used for this markup: `text`) to use for all
|
92 | 92 | # documents.
|
93 |
| -#default_role = None |
| 93 | +# default_role = None |
94 | 94 |
|
95 | 95 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
96 |
| -#add_function_parentheses = True |
| 96 | +# add_function_parentheses = True |
97 | 97 |
|
98 | 98 | # If true, the current module name will be prepended to all description
|
99 | 99 | # unit titles (such as .. function::).
|
100 |
| -#add_module_names = True |
| 100 | +# add_module_names = True |
101 | 101 |
|
102 | 102 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
103 | 103 | # output. They are ignored by default.
|
104 |
| -#show_authors = False |
| 104 | +# show_authors = False |
105 | 105 |
|
106 | 106 | # The name of the Pygments (syntax highlighting) style to use.
|
107 |
| -pygments_style = 'sphinx' |
| 107 | +pygments_style = "sphinx" |
108 | 108 |
|
109 | 109 | # A list of ignored prefixes for module index sorting.
|
110 |
| -#modindex_common_prefix = [] |
| 110 | +# modindex_common_prefix = [] |
111 | 111 |
|
112 | 112 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
113 |
| -#keep_warnings = False |
| 113 | +# keep_warnings = False |
114 | 114 |
|
115 | 115 | # If true, `todo` and `todoList` produce output, else they produce nothing.
|
116 | 116 | todo_include_todos = True
|
|
120 | 120 |
|
121 | 121 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
122 | 122 | # a list of builtin themes.
|
123 |
| -html_theme = 'sphinx_rtd_theme' |
| 123 | +html_theme = "sphinx_rtd_theme" |
124 | 124 |
|
125 | 125 | # Theme options are theme-specific and customize the look and feel of a theme
|
126 | 126 | # further. For a list of options available for each theme, see the
|
127 | 127 | # documentation.
|
128 |
| -#html_theme_options = {} |
| 128 | +# html_theme_options = {} |
129 | 129 |
|
130 | 130 | # Add any paths that contain custom themes here, relative to this directory.
|
131 |
| -#html_theme_path = [] |
| 131 | +# html_theme_path = [] |
132 | 132 |
|
133 | 133 | # The name for this set of Sphinx documents. If None, it defaults to
|
134 | 134 | # "<project> v<release> documentation".
|
135 |
| -#html_title = None |
| 135 | +# html_title = None |
136 | 136 |
|
137 | 137 | # A shorter title for the navigation bar. Default is the same as html_title.
|
138 |
| -#html_short_title = None |
| 138 | +# html_short_title = None |
139 | 139 |
|
140 | 140 | # The name of an image file (relative to this directory) to place at the top
|
141 | 141 | # of the sidebar.
|
142 |
| -#html_logo = None |
| 142 | +# html_logo = None |
143 | 143 |
|
144 | 144 | # The name of an image file (within the static path) to use as favicon of the
|
145 | 145 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
146 | 146 | # pixels large.
|
147 |
| -#html_favicon = None |
| 147 | +# html_favicon = None |
148 | 148 |
|
149 | 149 | # Add any paths that contain custom static files (such as style sheets) here,
|
150 | 150 | # relative to this directory. They are copied after the builtin static files,
|
|
154 | 154 | # Add any extra paths that contain custom files (such as robots.txt or
|
155 | 155 | # .htaccess) here, relative to this directory. These files are copied
|
156 | 156 | # directly to the root of the documentation.
|
157 |
| -#html_extra_path = [] |
| 157 | +# html_extra_path = [] |
158 | 158 |
|
159 | 159 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
160 | 160 | # using the given strftime format.
|
161 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 161 | +# html_last_updated_fmt = '%b %d, %Y' |
162 | 162 |
|
163 | 163 | # If true, SmartyPants will be used to convert quotes and dashes to
|
164 | 164 | # typographically correct entities.
|
165 |
| -#html_use_smartypants = True |
| 165 | +# html_use_smartypants = True |
166 | 166 |
|
167 | 167 | # Custom sidebar templates, maps document names to template names.
|
168 |
| -#html_sidebars = {} |
| 168 | +# html_sidebars = {} |
169 | 169 |
|
170 | 170 | # Additional templates that should be rendered to pages, maps page names to
|
171 | 171 | # template names.
|
172 |
| -#html_additional_pages = {} |
| 172 | +# html_additional_pages = {} |
173 | 173 |
|
174 | 174 | # If false, no module index is generated.
|
175 |
| -#html_domain_indices = True |
| 175 | +# html_domain_indices = True |
176 | 176 |
|
177 | 177 | # If false, no index is generated.
|
178 |
| -#html_use_index = True |
| 178 | +# html_use_index = True |
179 | 179 |
|
180 | 180 | # If true, the index is split into individual pages for each letter.
|
181 |
| -#html_split_index = False |
| 181 | +# html_split_index = False |
182 | 182 |
|
183 | 183 | # If true, links to the reST sources are added to the pages.
|
184 |
| -#html_show_sourcelink = True |
| 184 | +# html_show_sourcelink = True |
185 | 185 |
|
186 | 186 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
187 |
| -#html_show_sphinx = True |
| 187 | +# html_show_sphinx = True |
188 | 188 |
|
189 | 189 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
190 |
| -#html_show_copyright = True |
| 190 | +# html_show_copyright = True |
191 | 191 |
|
192 | 192 | # If true, an OpenSearch description file will be output, and all pages will
|
193 | 193 | # contain a <link> tag referring to it. The value of this option must be the
|
194 | 194 | # base URL from which the finished HTML is served.
|
195 |
| -#html_use_opensearch = '' |
| 195 | +# html_use_opensearch = '' |
196 | 196 |
|
197 | 197 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
198 |
| -#html_file_suffix = None |
| 198 | +# html_file_suffix = None |
199 | 199 |
|
200 | 200 | # Language to be used for generating the HTML full-text search index.
|
201 | 201 | # Sphinx supports the following languages:
|
202 | 202 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
203 | 203 | # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
204 |
| -#html_search_language = 'en' |
| 204 | +# html_search_language = 'en' |
205 | 205 |
|
206 | 206 | # A dictionary with options for the search language support, empty by default.
|
207 | 207 | # Now only 'ja' uses this config value
|
208 |
| -#html_search_options = {'type': 'default'} |
| 208 | +# html_search_options = {'type': 'default'} |
209 | 209 |
|
210 | 210 | # The name of a javascript file (relative to the configuration directory) that
|
211 | 211 | # implements a search results scorer. If empty, the default will be used.
|
212 |
| -#html_search_scorer = 'scorer.js' |
| 212 | +# html_search_scorer = 'scorer.js' |
213 | 213 |
|
214 | 214 | # Output file base name for HTML help builder.
|
215 |
| -htmlhelp_basename = 'flake8doc' |
| 215 | +htmlhelp_basename = "flake8doc" |
216 | 216 |
|
217 | 217 | # -- Options for LaTeX output ---------------------------------------------
|
218 | 218 |
|
219 | 219 | latex_elements = {
|
220 |
| -# The paper size ('letterpaper' or 'a4paper'). |
221 |
| -#'papersize': 'letterpaper', |
222 |
| - |
223 |
| -# The font size ('10pt', '11pt' or '12pt'). |
224 |
| -#'pointsize': '10pt', |
225 |
| - |
226 |
| -# Additional stuff for the LaTeX preamble. |
227 |
| -#'preamble': '', |
228 |
| - |
229 |
| -# Latex figure (float) alignment |
230 |
| -#'figure_align': 'htbp', |
| 220 | + # The paper size ('letterpaper' or 'a4paper'). |
| 221 | + #'papersize': 'letterpaper', |
| 222 | + # The font size ('10pt', '11pt' or '12pt'). |
| 223 | + #'pointsize': '10pt', |
| 224 | + # Additional stuff for the LaTeX preamble. |
| 225 | + #'preamble': '', |
| 226 | + # Latex figure (float) alignment |
| 227 | + #'figure_align': 'htbp', |
231 | 228 | }
|
232 | 229 |
|
233 | 230 | # Grouping the document tree into LaTeX files. List of tuples
|
234 | 231 | # (source start file, target name, title,
|
235 | 232 | # author, documentclass [howto, manual, or own class]).
|
236 | 233 | latex_documents = [
|
237 |
| - (master_doc, 'flake8.tex', 'flake8 Documentation', |
238 |
| - 'Ian Stapleton Cordasco', 'manual'), |
| 234 | + ( |
| 235 | + master_doc, |
| 236 | + "flake8.tex", |
| 237 | + "flake8 Documentation", |
| 238 | + "Ian Stapleton Cordasco", |
| 239 | + "manual", |
| 240 | + ), |
239 | 241 | ]
|
240 | 242 |
|
241 | 243 | # The name of an image file (relative to this directory) to place at the top of
|
242 | 244 | # the title page.
|
243 |
| -#latex_logo = None |
| 245 | +# latex_logo = None |
244 | 246 |
|
245 | 247 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
246 | 248 | # not chapters.
|
247 |
| -#latex_use_parts = False |
| 249 | +# latex_use_parts = False |
248 | 250 |
|
249 | 251 | # If true, show page references after internal links.
|
250 |
| -#latex_show_pagerefs = False |
| 252 | +# latex_show_pagerefs = False |
251 | 253 |
|
252 | 254 | # If true, show URL addresses after external links.
|
253 |
| -#latex_show_urls = False |
| 255 | +# latex_show_urls = False |
254 | 256 |
|
255 | 257 | # Documents to append as an appendix to all manuals.
|
256 |
| -#latex_appendices = [] |
| 258 | +# latex_appendices = [] |
257 | 259 |
|
258 | 260 | # If false, no module index is generated.
|
259 |
| -#latex_domain_indices = True |
| 261 | +# latex_domain_indices = True |
260 | 262 |
|
261 | 263 |
|
262 | 264 | # -- Options for manual page output ---------------------------------------
|
263 | 265 |
|
264 | 266 | # One entry per manual page. List of tuples
|
265 | 267 | # (source start file, name, description, authors, manual section).
|
266 | 268 | man_pages = [
|
267 |
| - ('manpage', 'flake8', 'Flake8 Command Line Documentation', |
268 |
| - [author], 1) |
| 269 | + ("manpage", "flake8", "Flake8 Command Line Documentation", [author], 1) |
269 | 270 | ]
|
270 | 271 |
|
271 | 272 | # If true, show URL addresses after external links.
|
272 |
| -#man_show_urls = False |
| 273 | +# man_show_urls = False |
273 | 274 |
|
274 | 275 |
|
275 | 276 | # -- Options for Texinfo output -------------------------------------------
|
|
278 | 279 | # (source start file, target name, title, author,
|
279 | 280 | # dir menu entry, description, category)
|
280 | 281 | texinfo_documents = [
|
281 |
| - ('index', 'Flake8', 'Flake8 Documentation', 'Tarek Ziade', |
282 |
| - 'Flake8', 'Code checking using pycodestyle, pyflakes and mccabe', |
283 |
| - 'Miscellaneous'), |
| 282 | + ( |
| 283 | + "index", |
| 284 | + "Flake8", |
| 285 | + "Flake8 Documentation", |
| 286 | + "Tarek Ziade", |
| 287 | + "Flake8", |
| 288 | + "Code checking using pycodestyle, pyflakes and mccabe", |
| 289 | + "Miscellaneous", |
| 290 | + ), |
284 | 291 | ]
|
285 | 292 |
|
286 | 293 | # Documents to append as an appendix to all manuals.
|
287 |
| -#texinfo_appendices = [] |
| 294 | +# texinfo_appendices = [] |
288 | 295 |
|
289 | 296 | # If false, no module index is generated.
|
290 |
| -#texinfo_domain_indices = True |
| 297 | +# texinfo_domain_indices = True |
291 | 298 |
|
292 | 299 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
293 |
| -#texinfo_show_urls = 'footnote' |
| 300 | +# texinfo_show_urls = 'footnote' |
294 | 301 |
|
295 | 302 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
296 |
| -#texinfo_no_detailmenu = False |
| 303 | +# texinfo_no_detailmenu = False |
297 | 304 |
|
298 | 305 |
|
299 | 306 | # Example configuration for intersphinx: refer to the Python standard library.
|
300 |
| -intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)} |
| 307 | +intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)} |
301 | 308 |
|
302 | 309 | extlinks = {
|
303 | 310 | "issue": ("https://github.com/pycqa/flake8/issues/%s", "#"),
|
|
0 commit comments