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