|
18 | 18 | # If extensions (or modules to document with autodoc) are in another directory, |
19 | 19 | # add these directories to sys.path here. If the directory is relative to the |
20 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
21 | | -sys.path.insert(0, os.path.abspath('..')) |
| 21 | +sys.path.insert(0, os.path.abspath("..")) |
22 | 22 |
|
23 | 23 | from docx import __version__ # noqa |
24 | 24 |
|
|
31 | 31 | # Add any Sphinx extension module names here, as strings. They can be |
32 | 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
33 | 33 | extensions = [ |
34 | | - 'sphinx.ext.autodoc', |
35 | | - 'sphinx.ext.intersphinx', |
36 | | - 'sphinx.ext.todo', |
37 | | - 'sphinx.ext.coverage', |
38 | | - 'sphinx.ext.viewcode' |
| 34 | + "sphinx.ext.autodoc", |
| 35 | + "sphinx.ext.intersphinx", |
| 36 | + "sphinx.ext.todo", |
| 37 | + "sphinx.ext.coverage", |
| 38 | + "sphinx.ext.viewcode", |
39 | 39 | ] |
40 | 40 |
|
41 | 41 | # Add any paths that contain templates here, relative to this directory. |
42 | | -templates_path = ['_templates'] |
| 42 | +templates_path = ["_templates"] |
43 | 43 |
|
44 | 44 | # The suffix of source filenames. |
45 | | -source_suffix = '.rst' |
| 45 | +source_suffix = ".rst" |
46 | 46 |
|
47 | 47 | # The encoding of source files. |
48 | 48 | # source_encoding = 'utf-8-sig' |
49 | 49 |
|
50 | 50 | # The master toctree document. |
51 | | -master_doc = 'index' |
| 51 | +master_doc = "index" |
52 | 52 |
|
53 | 53 | # General information about the project. |
54 | | -project = u'python-docx' |
55 | | -copyright = u'2013, Steve Canny' |
| 54 | +project = "python-docx" |
| 55 | +copyright = "2013, Steve Canny" |
56 | 56 |
|
57 | 57 | # The version info for the project you're documenting, acts as replacement for |
58 | 58 | # |version| and |release|, also used in various other places throughout the |
|
193 | 193 |
|
194 | 194 | # List of patterns, relative to source directory, that match files and |
195 | 195 | # directories to ignore when looking for source files. |
196 | | -exclude_patterns = ['.build'] |
| 196 | +exclude_patterns = [".build"] |
197 | 197 |
|
198 | 198 | # The reST default role (used for this markup: `text`) to use for all |
199 | 199 | # documents. |
|
211 | 211 | # show_authors = False |
212 | 212 |
|
213 | 213 | # The name of the Pygments (syntax highlighting) style to use. |
214 | | -pygments_style = 'sphinx' |
| 214 | +pygments_style = "sphinx" |
215 | 215 |
|
216 | 216 | # A list of ignored prefixes for module index sorting. |
217 | 217 | # modindex_common_prefix = [] |
|
221 | 221 |
|
222 | 222 | # The theme to use for HTML and HTML Help pages. See the documentation for |
223 | 223 | # a list of builtin themes. |
224 | | -html_theme = 'armstrong' |
| 224 | +html_theme = "armstrong" |
225 | 225 |
|
226 | 226 | # Theme options are theme-specific and customize the look and feel of a theme |
227 | 227 | # further. For a list of options available for each theme, see the |
228 | 228 | # documentation. |
229 | 229 | # html_theme_options = {} |
230 | 230 |
|
231 | 231 | # Add any paths that contain custom themes here, relative to this directory. |
232 | | -html_theme_path = ['_themes'] |
| 232 | +html_theme_path = ["_themes"] |
233 | 233 |
|
234 | 234 | # The name for this set of Sphinx documents. If None, it defaults to |
235 | 235 | # "<project> v<release> documentation". |
|
250 | 250 | # Add any paths that contain custom static files (such as style sheets) here, |
251 | 251 | # relative to this directory. They are copied after the builtin static files, |
252 | 252 | # so a file named "default.css" will overwrite the builtin "default.css". |
253 | | -html_static_path = ['_static'] |
| 253 | +html_static_path = ["_static"] |
254 | 254 |
|
255 | 255 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
256 | 256 | # using the given strftime format. |
|
263 | 263 | # Custom sidebar templates, maps document names to template names. |
264 | 264 | # html_sidebars = {} |
265 | 265 | html_sidebars = { |
266 | | - '**': ['localtoc.html', 'relations.html', 'sidebarlinks.html', |
267 | | - 'searchbox.html'] |
| 266 | + "**": ["localtoc.html", "relations.html", "sidebarlinks.html", "searchbox.html"] |
268 | 267 | } |
269 | 268 |
|
270 | 269 | # Additional templates that should be rendered to pages, maps page names to |
|
298 | 297 | # html_file_suffix = None |
299 | 298 |
|
300 | 299 | # Output file base name for HTML help builder. |
301 | | -htmlhelp_basename = 'python-docxdoc' |
| 300 | +htmlhelp_basename = "python-docxdoc" |
302 | 301 |
|
303 | 302 |
|
304 | 303 | # -- Options for LaTeX output ----------------------------------------------- |
305 | 304 |
|
306 | 305 | latex_elements = { |
307 | 306 | # The paper size ('letterpaper' or 'a4paper'). |
308 | 307 | # 'papersize': 'letterpaper', |
309 | | - |
310 | 308 | # The font size ('10pt', '11pt' or '12pt'). |
311 | 309 | # 'pointsize': '10pt', |
312 | | - |
313 | 310 | # Additional stuff for the LaTeX preamble. |
314 | 311 | # 'preamble': '', |
315 | 312 | } |
|
321 | 318 | # author, |
322 | 319 | # documentclass [howto/manual]). |
323 | 320 | latex_documents = [ |
324 | | - ('index', 'python-docx.tex', u'python-docx Documentation', |
325 | | - u'Steve Canny', 'manual'), |
| 321 | + ("index", "python-docx.tex", "python-docx Documentation", "Steve Canny", "manual"), |
326 | 322 | ] |
327 | 323 |
|
328 | 324 | # The name of an image file (relative to this directory) to place at the top of |
|
350 | 346 |
|
351 | 347 | # One entry per manual page. List of tuples |
352 | 348 | # (source start file, name, description, authors, manual section). |
353 | | -man_pages = [ |
354 | | - ('index', 'python-docx', u'python-docx Documentation', |
355 | | - [u'Steve Canny'], 1) |
356 | | -] |
| 349 | +man_pages = [("index", "python-docx", "python-docx Documentation", ["Steve Canny"], 1)] |
357 | 350 |
|
358 | 351 | # If true, show URL addresses after external links. |
359 | 352 | # man_show_urls = False |
|
365 | 358 | # (source start file, target name, title, author, |
366 | 359 | # dir menu entry, description, category) |
367 | 360 | texinfo_documents = [ |
368 | | - ('index', 'python-docx', u'python-docx Documentation', |
369 | | - u'Steve Canny', 'python-docx', 'One line description of project.', |
370 | | - 'Miscellaneous'), |
| 361 | + ( |
| 362 | + "index", |
| 363 | + "python-docx", |
| 364 | + "python-docx Documentation", |
| 365 | + "Steve Canny", |
| 366 | + "python-docx", |
| 367 | + "One line description of project.", |
| 368 | + "Miscellaneous", |
| 369 | + ), |
371 | 370 | ] |
372 | 371 |
|
373 | 372 | # Documents to append as an appendix to all manuals. |
|
381 | 380 |
|
382 | 381 |
|
383 | 382 | # Example configuration for intersphinx: refer to the Python standard library. |
384 | | -intersphinx_mapping = {'http://docs.python.org/3/': None} |
| 383 | +intersphinx_mapping = {"http://docs.python.org/3/": None} |
0 commit comments