|
124 | 124 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
125 | 125 | todo_include_todos = False |
126 | 126 |
|
127 | | - |
128 | 127 | # -- Options for HTML output ---------------------------------------------- |
129 | 128 |
|
130 | 129 | # The theme to use for HTML and HTML Help pages. See the documentation for |
131 | 130 | # a list of builtin themes. |
132 | 131 | html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() |
133 | 132 | html_theme = 'bootstrap' |
134 | 133 | html_theme_options = { |
135 | | - 'bootswatch_theme': 'yeti', |
136 | | - 'navbar_links' : [ |
137 | | - ("GitHub", "https://github.com/ev3dev/ev3dev-lang-python", True) |
138 | | - ] |
139 | | - } |
| 134 | + 'bootswatch_theme': 'yeti', |
| 135 | + 'navbar_links': [("GitHub", "https://github.com/ev3dev/ev3dev-lang-python", True)] |
| 136 | +} |
140 | 137 |
|
141 | 138 | # Theme options are theme-specific and customize the look and feel of a theme |
142 | 139 | # further. For a list of options available for each theme, see the |
|
233 | 230 | # -- Options for LaTeX output --------------------------------------------- |
234 | 231 |
|
235 | 232 | latex_elements = { |
236 | | -# The paper size ('letterpaper' or 'a4paper'). |
237 | | -#'papersize': 'letterpaper', |
| 233 | + # The paper size ('letterpaper' or 'a4paper'). |
| 234 | + #'papersize': 'letterpaper', |
238 | 235 |
|
239 | | -# The font size ('10pt', '11pt' or '12pt'). |
240 | | -#'pointsize': '10pt', |
| 236 | + # The font size ('10pt', '11pt' or '12pt'). |
| 237 | + #'pointsize': '10pt', |
241 | 238 |
|
242 | | -# Additional stuff for the LaTeX preamble. |
243 | | -#'preamble': '', |
| 239 | + # Additional stuff for the LaTeX preamble. |
| 240 | + #'preamble': '', |
244 | 241 |
|
245 | | -# Latex figure (float) alignment |
246 | | -#'figure_align': 'htbp', |
| 242 | + # Latex figure (float) alignment |
| 243 | + #'figure_align': 'htbp', |
247 | 244 | } |
248 | 245 |
|
249 | 246 | # Grouping the document tree into LaTeX files. List of tuples |
250 | 247 | # (source start file, target name, title, |
251 | 248 | # author, documentclass [howto, manual, or own class]). |
252 | 249 | latex_documents = [ |
253 | | - (master_doc, 'python-ev3dev.tex', 'python-ev3dev Documentation', |
254 | | - 'Ralph Hempel et al', 'manual'), |
| 250 | + (master_doc, 'python-ev3dev.tex', 'python-ev3dev Documentation', 'Ralph Hempel et al', 'manual'), |
255 | 251 | ] |
256 | 252 |
|
257 | 253 | # The name of an image file (relative to this directory) to place at the top of |
|
274 | 270 | # If false, no module index is generated. |
275 | 271 | #latex_domain_indices = True |
276 | 272 |
|
277 | | - |
278 | 273 | # -- Options for manual page output --------------------------------------- |
279 | 274 |
|
280 | 275 | # One entry per manual page. List of tuples |
281 | 276 | # (source start file, name, description, authors, manual section). |
282 | | -man_pages = [ |
283 | | - (master_doc, 'python-ev3dev', 'python-ev3dev Documentation', |
284 | | - [author], 1) |
285 | | -] |
| 277 | +man_pages = [(master_doc, 'python-ev3dev', 'python-ev3dev Documentation', [author], 1)] |
286 | 278 |
|
287 | 279 | # If true, show URL addresses after external links. |
288 | 280 | #man_show_urls = False |
289 | 281 |
|
290 | | - |
291 | 282 | # -- Options for Texinfo output ------------------------------------------- |
292 | 283 |
|
293 | 284 | # Grouping the document tree into Texinfo files. List of tuples |
294 | 285 | # (source start file, target name, title, author, |
295 | 286 | # dir menu entry, description, category) |
296 | 287 | texinfo_documents = [ |
297 | | - (master_doc, 'python-ev3dev', 'python-ev3dev Documentation', |
298 | | - author, 'python-ev3dev', 'One line description of project.', |
299 | | - 'Miscellaneous'), |
| 288 | + (master_doc, 'python-ev3dev', 'python-ev3dev Documentation', author, 'python-ev3dev', |
| 289 | + 'One line description of project.', 'Miscellaneous'), |
300 | 290 | ] |
301 | 291 |
|
302 | 292 | # Documents to append as an appendix to all manuals. |
|
315 | 305 |
|
316 | 306 | suppress_warnings = ['image.nonlocal_uri'] |
317 | 307 |
|
318 | | -nitpick_ignore = [ |
319 | | - ('py:class', 'ev3dev2.display.FbMem'), |
320 | | - ('py:class', 'ev3dev2.button.ButtonBase'), |
321 | | - ('py:class', 'int'), |
322 | | - ('py:class', 'float'), |
323 | | - ('py:class', 'string'), |
324 | | - ('py:class', 'iterable'), |
325 | | - ('py:class', 'tuple'), |
326 | | - ('py:class', 'list'), |
327 | | - ('py:exc', 'ValueError') |
328 | | -] |
| 308 | +nitpick_ignore = [('py:class', 'ev3dev2.display.FbMem'), ('py:class', 'ev3dev2.button.ButtonBase'), ('py:class', 'int'), |
| 309 | + ('py:class', 'float'), ('py:class', 'string'), ('py:class', 'iterable'), ('py:class', 'tuple'), |
| 310 | + ('py:class', 'list'), ('py:exc', 'ValueError')] |
| 311 | + |
329 | 312 |
|
330 | 313 | def setup(app): |
331 | 314 | app.add_config_value('recommonmark_config', { |
332 | | - 'enable_eval_rst': True, |
333 | | - }, True) |
| 315 | + 'enable_eval_rst': True, |
| 316 | + }, True) |
334 | 317 | app.add_transform(AutoStructify) |
0 commit comments