|
22 | 22 | 0, os.path.split(os.path.split(os.path.dirname(os.path.abspath(
|
23 | 23 | __file__)))[0])[0])
|
24 | 24 |
|
25 |
| -from pytest_order import __version__ |
| 25 | +from pytest_order import __version__ # noqa: E402 |
26 | 26 |
|
27 | 27 | # -- General configuration ------------------------------------------------
|
28 | 28 |
|
29 | 29 | # If your documentation needs a minimal Sphinx version, state it here.
|
30 |
| -#needs_sphinx = '1.0' |
| 30 | +# needs_sphinx = '1.0' |
31 | 31 |
|
32 | 32 | # Add any Sphinx extension module names here, as strings. They can be
|
33 | 33 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
47 | 47 | source_suffix = '.rst'
|
48 | 48 |
|
49 | 49 | # The encoding of source files.
|
50 |
| -#source_encoding = 'utf-8-sig' |
| 50 | +# source_encoding = 'utf-8-sig' |
51 | 51 |
|
52 | 52 | # The master toctree document.
|
53 | 53 | master_doc = 'index'
|
|
68 | 68 |
|
69 | 69 | # The language for content autogenerated by Sphinx. Refer to documentation
|
70 | 70 | # for a list of supported languages.
|
71 |
| -#language = None |
| 71 | +# language = None |
72 | 72 |
|
73 | 73 | # There are two options for replacing |today|: either, you set today to some
|
74 | 74 | # non-false value, then it is used:
|
75 |
| -#today = '' |
| 75 | +# today = '' |
76 | 76 | # Else, today_fmt is used as the format for a strftime call.
|
77 |
| -#today_fmt = '%B %d, %Y' |
| 77 | +# today_fmt = '%B %d, %Y' |
78 | 78 |
|
79 | 79 | # List of patterns, relative to source directory, that match files and
|
80 | 80 | # directories to ignore when looking for source files.
|
81 | 81 | exclude_patterns = []
|
82 | 82 |
|
83 | 83 | # The reST default role (used for this markup: `text`) to use for all
|
84 | 84 | # documents.
|
85 |
| -#default_role = None |
| 85 | +# default_role = None |
86 | 86 |
|
87 | 87 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
88 |
| -#add_function_parentheses = True |
| 88 | +# add_function_parentheses = True |
89 | 89 |
|
90 | 90 | # If true, the current module name will be prepended to all description
|
91 | 91 | # unit titles (such as .. function::).
|
92 |
| -#add_module_names = True |
| 92 | +# add_module_names = True |
93 | 93 |
|
94 | 94 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
95 | 95 | # output. They are ignored by default.
|
96 |
| -#show_authors = False |
| 96 | +# show_authors = False |
97 | 97 |
|
98 | 98 | # The name of the Pygments (syntax highlighting) style to use.
|
99 | 99 | pygments_style = 'sphinx'
|
100 | 100 |
|
101 | 101 | # A list of ignored prefixes for module index sorting.
|
102 |
| -#modindex_common_prefix = [] |
| 102 | +# modindex_common_prefix = [] |
103 | 103 |
|
104 | 104 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
105 |
| -#keep_warnings = False |
| 105 | +# keep_warnings = False |
106 | 106 |
|
107 | 107 |
|
108 | 108 | # -- Options for HTML output ----------------------------------------------
|
|
114 | 114 | # Theme options are theme-specific and customize the look and feel of a theme
|
115 | 115 | # further. For a list of options available for each theme, see the
|
116 | 116 | # documentation.
|
117 |
| -#html_theme_options = {} |
| 117 | +# html_theme_options = {} |
118 | 118 |
|
119 | 119 | # Add any paths that contain custom themes here, relative to this directory.
|
120 |
| -#html_theme_path = [] |
| 120 | +# html_theme_path = [] |
121 | 121 |
|
122 | 122 | # The name for this set of Sphinx documents. If None, it defaults to
|
123 | 123 | # "<project> v<release> documentation".
|
124 |
| -#html_title = None |
| 124 | +# html_title = None |
125 | 125 |
|
126 | 126 | # A shorter title for the navigation bar. Default is the same as html_title.
|
127 |
| -#html_short_title = None |
| 127 | +# html_short_title = None |
128 | 128 |
|
129 | 129 | # The name of an image file (relative to this directory) to place at the top
|
130 | 130 | # of the sidebar.
|
131 |
| -#html_logo = None |
| 131 | +# html_logo = None |
132 | 132 |
|
133 | 133 | # The name of an image file (within the static path) to use as favicon of the
|
134 | 134 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
135 | 135 | # pixels large.
|
136 |
| -#html_favicon = None |
| 136 | +# html_favicon = None |
137 | 137 |
|
138 | 138 | # Add any paths that contain custom static files (such as style sheets) here,
|
139 | 139 | # relative to this directory. They are copied after the builtin static files,
|
|
143 | 143 | # Add any extra paths that contain custom files (such as robots.txt or
|
144 | 144 | # .htaccess) here, relative to this directory. These files are copied
|
145 | 145 | # directly to the root of the documentation.
|
146 |
| -#html_extra_path = [] |
| 146 | +# html_extra_path = [] |
147 | 147 |
|
148 | 148 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
149 | 149 | # using the given strftime format.
|
150 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 150 | +# html_last_updated_fmt = '%b %d, %Y' |
151 | 151 |
|
152 | 152 | # If true, SmartyPants will be used to convert quotes and dashes to
|
153 | 153 | # typographically correct entities.
|
154 |
| -#html_use_smartypants = True |
| 154 | +# html_use_smartypants = True |
155 | 155 |
|
156 | 156 | # Custom sidebar templates, maps document names to template names.
|
157 |
| -#html_sidebars = {} |
| 157 | +# html_sidebars = {} |
158 | 158 |
|
159 | 159 | # Additional templates that should be rendered to pages, maps page names to
|
160 | 160 | # template names.
|
161 |
| -#html_additional_pages = {} |
| 161 | +# html_additional_pages = {} |
162 | 162 |
|
163 | 163 | # If false, no module index is generated.
|
164 |
| -#html_domain_indices = True |
| 164 | +# html_domain_indices = True |
165 | 165 |
|
166 | 166 | # If false, no index is generated.
|
167 |
| -#html_use_index = True |
| 167 | +# html_use_index = True |
168 | 168 |
|
169 | 169 | # If true, the index is split into individual pages for each letter.
|
170 |
| -#html_split_index = False |
| 170 | +# html_split_index = False |
171 | 171 |
|
172 | 172 | # If true, links to the reST sources are added to the pages.
|
173 |
| -#html_show_sourcelink = True |
| 173 | +# html_show_sourcelink = True |
174 | 174 |
|
175 | 175 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
176 | 176 | html_show_sphinx = False
|
177 | 177 |
|
178 | 178 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
179 |
| -#html_show_copyright = True |
| 179 | +# html_show_copyright = True |
180 | 180 |
|
181 | 181 | # If true, an OpenSearch description file will be output, and all pages will
|
182 | 182 | # contain a <link> tag referring to it. The value of this option must be the
|
183 | 183 | # base URL from which the finished HTML is served.
|
184 |
| -#html_use_opensearch = '' |
| 184 | +# html_use_opensearch = '' |
185 | 185 |
|
186 | 186 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
187 |
| -#html_file_suffix = None |
| 187 | +# html_file_suffix = None |
188 | 188 |
|
189 | 189 | # Output file base name for HTML help builder.
|
190 | 190 | htmlhelp_basename = 'pytest-orderdoc'
|
191 | 191 |
|
192 |
| - |
193 | 192 | # -- Options for LaTeX output ---------------------------------------------
|
194 | 193 |
|
195 | 194 | latex_elements = {
|
196 |
| -# The paper size ('letterpaper' or 'a4paper'). |
197 |
| -#'papersize': 'letterpaper', |
| 195 | + # The paper size ('letterpaper' or 'a4paper'). |
| 196 | + # 'papersize': 'letterpaper', |
198 | 197 |
|
199 |
| -# The font size ('10pt', '11pt' or '12pt'). |
200 |
| -#'pointsize': '10pt', |
| 198 | + # The font size ('10pt', '11pt' or '12pt'). |
| 199 | + # 'pointsize': '10pt', |
201 | 200 |
|
202 |
| -# Additional stuff for the LaTeX preamble. |
203 |
| -#'preamble': '', |
| 201 | + # Additional stuff for the LaTeX preamble. |
| 202 | + # 'preamble': '', |
204 | 203 | }
|
205 | 204 |
|
206 | 205 | # Grouping the document tree into LaTeX files. List of tuples
|
207 | 206 | # (source start file, target name, title,
|
208 | 207 | # author, documentclass [howto, manual, or own class]).
|
209 | 208 | latex_documents = [
|
210 |
| - ('index', 'pytest-order.tex', u'pytest-order Documentation', |
211 |
| - u'Frank Tobia', 'manual'), |
| 209 | + ('index', 'pytest-order.tex', u'pytest-order Documentation', |
| 210 | + u'Frank Tobia', 'manual'), |
212 | 211 | ]
|
213 | 212 |
|
214 | 213 | # The name of an image file (relative to this directory) to place at the top of
|
215 | 214 | # the title page.
|
216 |
| -#latex_logo = None |
| 215 | +# latex_logo = None |
217 | 216 |
|
218 | 217 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
219 | 218 | # not chapters.
|
220 |
| -#latex_use_parts = False |
| 219 | +# latex_use_parts = False |
221 | 220 |
|
222 | 221 | # If true, show page references after internal links.
|
223 |
| -#latex_show_pagerefs = False |
| 222 | +# latex_show_pagerefs = False |
224 | 223 |
|
225 | 224 | # If true, show URL addresses after external links.
|
226 |
| -#latex_show_urls = False |
| 225 | +# latex_show_urls = False |
227 | 226 |
|
228 | 227 | # Documents to append as an appendix to all manuals.
|
229 |
| -#latex_appendices = [] |
| 228 | +# latex_appendices = [] |
230 | 229 |
|
231 | 230 | # If false, no module index is generated.
|
232 |
| -#latex_domain_indices = True |
| 231 | +# latex_domain_indices = True |
233 | 232 |
|
234 | 233 |
|
235 | 234 | # -- Options for manual page output ---------------------------------------
|
|
242 | 241 | ]
|
243 | 242 |
|
244 | 243 | # If true, show URL addresses after external links.
|
245 |
| -#man_show_urls = False |
| 244 | +# man_show_urls = False |
246 | 245 |
|
247 | 246 |
|
248 | 247 | # -- Options for Texinfo output -------------------------------------------
|
|
251 | 250 | # (source start file, target name, title, author,
|
252 | 251 | # dir menu entry, description, category)
|
253 | 252 | texinfo_documents = [
|
254 |
| - ('index', 'pytest-order', u'pytest-order Documentation', |
255 |
| - u'Frank Tobia', 'pytest-order', 'One line description of project.', |
256 |
| - 'Miscellaneous'), |
| 253 | + ('index', 'pytest-order', u'pytest-order Documentation', |
| 254 | + u'Frank Tobia', 'pytest-order', 'One line description of project.', |
| 255 | + 'Miscellaneous'), |
257 | 256 | ]
|
258 | 257 |
|
259 | 258 | # Documents to append as an appendix to all manuals.
|
260 |
| -#texinfo_appendices = [] |
| 259 | +# texinfo_appendices = [] |
261 | 260 |
|
262 | 261 | # If false, no module index is generated.
|
263 |
| -#texinfo_domain_indices = True |
| 262 | +# texinfo_domain_indices = True |
264 | 263 |
|
265 | 264 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
266 |
| -#texinfo_show_urls = 'footnote' |
| 265 | +# texinfo_show_urls = 'footnote' |
267 | 266 |
|
268 | 267 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
269 |
| -#texinfo_no_detailmenu = False |
| 268 | +# texinfo_no_detailmenu = False |
0 commit comments