|
30 | 30 | # Add any Sphinx extension module names here, as strings. They can be |
31 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
32 | 32 | # ones. |
33 | | -extensions = ['sphinx.ext.autodoc', |
34 | | - 'sphinx.ext.autosummary', |
35 | | - 'sphinx.ext.doctest', |
36 | | - 'sphinx.ext.extlinks', |
37 | | - 'sphinx.ext.todo', |
38 | | - 'numpydoc', # used to parse numpy-style docstrings for autodoc |
39 | | - 'IPython.sphinxext.ipython_console_highlighting', |
40 | | - 'IPython.sphinxext.ipython_directive', |
41 | | - 'sphinx.ext.intersphinx', |
42 | | - 'sphinx.ext.coverage', |
43 | | - 'sphinx.ext.ifconfig', |
44 | | - ] |
| 33 | +extensions = [ |
| 34 | + "sphinx.ext.autodoc", |
| 35 | + "sphinx.ext.autosummary", |
| 36 | + "sphinx.ext.doctest", |
| 37 | + "sphinx.ext.extlinks", |
| 38 | + "sphinx.ext.todo", |
| 39 | + "numpydoc", # used to parse numpy-style docstrings for autodoc |
| 40 | + "IPython.sphinxext.ipython_console_highlighting", |
| 41 | + "IPython.sphinxext.ipython_directive", |
| 42 | + "sphinx.ext.intersphinx", |
| 43 | + "sphinx.ext.coverage", |
| 44 | + "sphinx.ext.ifconfig", |
| 45 | +] |
45 | 46 |
|
46 | 47 | # Add any paths that contain templates here, relative to this directory. |
47 | | -templates_path = ['_templates'] |
| 48 | +templates_path = ["_templates"] |
48 | 49 |
|
49 | 50 | # The suffix(es) of source filenames. |
50 | 51 | # You can specify multiple suffix as a list of string: |
51 | 52 | # |
52 | 53 | # source_suffix = ['.rst', '.md'] |
53 | | -source_suffix = '.rst' |
| 54 | +source_suffix = ".rst" |
54 | 55 |
|
55 | 56 | # The encoding of source files. |
56 | 57 | # |
57 | 58 | # source_encoding = 'utf-8-sig' |
58 | 59 |
|
59 | 60 | # The master toctree document. |
60 | | -master_doc = 'index' |
| 61 | +master_doc = "index" |
61 | 62 |
|
62 | 63 | # General information about the project. |
63 | | -project = u'pandas-gbq' |
64 | | -copyright = u'2017, PyData Development Team' |
65 | | -author = u'PyData Development Team' |
| 64 | +project = u"pandas-gbq" |
| 65 | +copyright = u"2017, PyData Development Team" |
| 66 | +author = u"PyData Development Team" |
66 | 67 |
|
67 | 68 | # The version info for the project you're documenting, acts as replacement for |
68 | 69 | # |version| and |release|, also used in various other places throughout the |
69 | 70 | # built documents. |
70 | 71 | # |
71 | 72 | # The short X.Y version. |
72 | | -version = u'0.1.0' |
| 73 | +version = u"0.1.0" |
73 | 74 | # The full version, including alpha/beta/rc tags. |
74 | | -release = u'0.1.0' |
| 75 | +release = u"0.1.0" |
75 | 76 |
|
76 | 77 | # The language for content autogenerated by Sphinx. Refer to documentation |
77 | 78 | # for a list of supported languages. |
|
92 | 93 | # List of patterns, relative to source directory, that match files and |
93 | 94 | # directories to ignore when looking for source files. |
94 | 95 | # This patterns also effect to html_static_path and html_extra_path |
95 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 96 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
96 | 97 |
|
97 | 98 | # The reST default role (used for this markup: `text`) to use for all |
98 | 99 | # documents. |
|
114 | 115 | # show_authors = False |
115 | 116 |
|
116 | 117 | # The name of the Pygments (syntax highlighting) style to use. |
117 | | -pygments_style = 'sphinx' |
| 118 | +pygments_style = "sphinx" |
118 | 119 |
|
119 | 120 | # A list of ignored prefixes for module index sorting. |
120 | 121 | # modindex_common_prefix = [] |
|
130 | 131 |
|
131 | 132 | # Taken from docs.readthedocs.io: |
132 | 133 | # on_rtd is whether we are on readthedocs.io |
133 | | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 134 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
134 | 135 |
|
135 | 136 | if not on_rtd: # only import and set the theme if we're building docs locally |
136 | 137 | import sphinx_rtd_theme |
137 | | - html_theme = 'sphinx_rtd_theme' |
| 138 | + |
| 139 | + html_theme = "sphinx_rtd_theme" |
138 | 140 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
139 | 141 |
|
140 | 142 | # The theme to use for HTML and HTML Help pages. See the documentation for |
|
174 | 176 | # Add any paths that contain custom static files (such as style sheets) here, |
175 | 177 | # relative to this directory. They are copied after the builtin static files, |
176 | 178 | # so a file named "default.css" will overwrite the builtin "default.css". |
177 | | -html_static_path = ['_static'] |
| 179 | +html_static_path = ["_static"] |
178 | 180 |
|
179 | 181 | # Add any extra paths that contain custom files (such as robots.txt or |
180 | 182 | # .htaccess) here, relative to this directory. These files are copied |
|
254 | 256 | # html_search_scorer = 'scorer.js' |
255 | 257 |
|
256 | 258 | # Output file base name for HTML help builder. |
257 | | -htmlhelp_basename = 'pandas-gbqdoc' |
| 259 | +htmlhelp_basename = "pandas-gbqdoc" |
258 | 260 |
|
259 | 261 | # -- Options for LaTeX output --------------------------------------------- |
260 | 262 |
|
261 | 263 | latex_elements = { |
262 | | - # The paper size ('letterpaper' or 'a4paper'). |
263 | | - # |
264 | | - # 'papersize': 'letterpaper', |
265 | | - |
266 | | - # The font size ('10pt', '11pt' or '12pt'). |
267 | | - # |
268 | | - # 'pointsize': '10pt', |
269 | | - |
270 | | - # Additional stuff for the LaTeX preamble. |
271 | | - # |
272 | | - # 'preamble': '', |
273 | | - |
274 | | - # Latex figure (float) alignment |
275 | | - # |
276 | | - # 'figure_align': 'htbp', |
| 264 | + # The paper size ('letterpaper' or 'a4paper'). |
| 265 | + # |
| 266 | + # 'papersize': 'letterpaper', |
| 267 | + # The font size ('10pt', '11pt' or '12pt'). |
| 268 | + # |
| 269 | + # 'pointsize': '10pt', |
| 270 | + # Additional stuff for the LaTeX preamble. |
| 271 | + # |
| 272 | + # 'preamble': '', |
| 273 | + # Latex figure (float) alignment |
| 274 | + # |
| 275 | + # 'figure_align': 'htbp', |
277 | 276 | } |
278 | 277 |
|
279 | 278 | # Grouping the document tree into LaTeX files. List of tuples |
280 | 279 | # (source start file, target name, title, |
281 | 280 | # author, documentclass [howto, manual, or own class]). |
282 | 281 | latex_documents = [ |
283 | | - (master_doc, 'pandas-gbq.tex', u'pandas-gbq Documentation', |
284 | | - u'PyData Development Team', 'manual'), |
| 282 | + ( |
| 283 | + master_doc, |
| 284 | + "pandas-gbq.tex", |
| 285 | + u"pandas-gbq Documentation", |
| 286 | + u"PyData Development Team", |
| 287 | + "manual", |
| 288 | + ) |
285 | 289 | ] |
286 | 290 |
|
287 | 291 | # The name of an image file (relative to this directory) to place at the top of |
|
322 | 326 | # One entry per manual page. List of tuples |
323 | 327 | # (source start file, name, description, authors, manual section). |
324 | 328 | man_pages = [ |
325 | | - (master_doc, 'pandas-gbq', u'pandas-gbq Documentation', |
326 | | - [author], 1) |
| 329 | + (master_doc, "pandas-gbq", u"pandas-gbq Documentation", [author], 1) |
327 | 330 | ] |
328 | 331 |
|
329 | 332 | # If true, show URL addresses after external links. |
|
337 | 340 | # (source start file, target name, title, author, |
338 | 341 | # dir menu entry, description, category) |
339 | 342 | texinfo_documents = [ |
340 | | - (master_doc, 'pandas-gbq', u'pandas-gbq Documentation', |
341 | | - author, 'pandas-gbq', 'One line description of project.', |
342 | | - 'Miscellaneous'), |
| 343 | + ( |
| 344 | + master_doc, |
| 345 | + "pandas-gbq", |
| 346 | + u"pandas-gbq Documentation", |
| 347 | + author, |
| 348 | + "pandas-gbq", |
| 349 | + "One line description of project.", |
| 350 | + "Miscellaneous", |
| 351 | + ) |
343 | 352 | ] |
344 | 353 |
|
345 | 354 | # Documents to append as an appendix to all manuals. |
|
361 | 370 |
|
362 | 371 | # Configuration for intersphinx: |
363 | 372 | intersphinx_mapping = { |
364 | | - 'https://docs.python.org/': None, |
365 | | - 'https://pandas.pydata.org/pandas-docs/stable/': None, |
366 | | - 'https://google-auth.readthedocs.io/en/latest/': None, |
| 373 | + "https://docs.python.org/": None, |
| 374 | + "https://pandas.pydata.org/pandas-docs/stable/": None, |
| 375 | + "https://google-auth.readthedocs.io/en/latest/": None, |
367 | 376 | } |
368 | 377 |
|
369 | | -extlinks = {'issue': ('https://github.com/pydata/pandas-gbq/issues/%s', |
370 | | - 'GH#'), |
371 | | - 'pr': ('https://github.com/pydata/pandas-gbq/pull/%s', 'GH#')} |
| 378 | +extlinks = { |
| 379 | + "issue": ("https://github.com/pydata/pandas-gbq/issues/%s", "GH#"), |
| 380 | + "pr": ("https://github.com/pydata/pandas-gbq/pull/%s", "GH#"), |
| 381 | +} |
0 commit comments