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