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