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