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