|
2 | 2 |
|
3 | 3 | import sphinx_graphene_theme
|
4 | 4 |
|
5 |
| -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 5 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
6 | 6 |
|
7 | 7 | # -*- coding: utf-8 -*-
|
8 | 8 | #
|
|
36 | 36 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
37 | 37 | # ones.
|
38 | 38 | extensions = [
|
39 |
| - 'sphinx.ext.autodoc', |
40 |
| - 'sphinx.ext.intersphinx', |
41 |
| - 'sphinx.ext.todo', |
42 |
| - 'sphinx.ext.coverage', |
43 |
| - 'sphinx.ext.viewcode', |
| 39 | + "sphinx.ext.autodoc", |
| 40 | + "sphinx.ext.intersphinx", |
| 41 | + "sphinx.ext.todo", |
| 42 | + "sphinx.ext.coverage", |
| 43 | + "sphinx.ext.viewcode", |
44 | 44 | ]
|
45 | 45 | if not on_rtd:
|
46 |
| - extensions += [ |
47 |
| - 'sphinx.ext.githubpages', |
48 |
| - ] |
| 46 | + extensions += ["sphinx.ext.githubpages"] |
49 | 47 |
|
50 | 48 | # Add any paths that contain templates here, relative to this directory.
|
51 |
| -templates_path = ['_templates'] |
| 49 | +templates_path = ["_templates"] |
52 | 50 |
|
53 | 51 | # The suffix(es) of source filenames.
|
54 | 52 | # You can specify multiple suffix as a list of string:
|
55 | 53 | #
|
56 | 54 | # source_suffix = ['.rst', '.md']
|
57 |
| -source_suffix = '.rst' |
| 55 | +source_suffix = ".rst" |
58 | 56 |
|
59 | 57 | # The encoding of source files.
|
60 | 58 | #
|
61 | 59 | # source_encoding = 'utf-8-sig'
|
62 | 60 |
|
63 | 61 | # The master toctree document.
|
64 |
| -master_doc = 'index' |
| 62 | +master_doc = "index" |
65 | 63 |
|
66 | 64 | # General information about the project.
|
67 |
| -project = u'Graphene' |
68 |
| -copyright = u'Graphene 2016' |
69 |
| -author = u'Syrus Akbary' |
| 65 | +project = u"Graphene" |
| 66 | +copyright = u"Graphene 2016" |
| 67 | +author = u"Syrus Akbary" |
70 | 68 |
|
71 | 69 | # The version info for the project you're documenting, acts as replacement for
|
72 | 70 | # |version| and |release|, also used in various other places throughout the
|
73 | 71 | # built documents.
|
74 | 72 | #
|
75 | 73 | # The short X.Y version.
|
76 |
| -version = u'1.0' |
| 74 | +version = u"1.0" |
77 | 75 | # The full version, including alpha/beta/rc tags.
|
78 |
| -release = u'1.0' |
| 76 | +release = u"1.0" |
79 | 77 |
|
80 | 78 | # The language for content autogenerated by Sphinx. Refer to documentation
|
81 | 79 | # for a list of supported languages.
|
|
96 | 94 | # List of patterns, relative to source directory, that match files and
|
97 | 95 | # directories to ignore when looking for source files.
|
98 | 96 | # This patterns also effect to html_static_path and html_extra_path
|
99 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 97 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
100 | 98 |
|
101 | 99 | # The reST default role (used for this markup: `text`) to use for all
|
102 | 100 | # documents.
|
|
118 | 116 | # show_authors = False
|
119 | 117 |
|
120 | 118 | # The name of the Pygments (syntax highlighting) style to use.
|
121 |
| -pygments_style = 'sphinx' |
| 119 | +pygments_style = "sphinx" |
122 | 120 |
|
123 | 121 | # A list of ignored prefixes for module index sorting.
|
124 | 122 | # modindex_common_prefix = []
|
|
175 | 173 | # Add any paths that contain custom static files (such as style sheets) here,
|
176 | 174 | # relative to this directory. They are copied after the builtin static files,
|
177 | 175 | # so a file named "default.css" will overwrite the builtin "default.css".
|
178 |
| -html_static_path = ['_static'] |
| 176 | +html_static_path = ["_static"] |
179 | 177 |
|
180 | 178 | # Add any extra paths that contain custom files (such as robots.txt or
|
181 | 179 | # .htaccess) here, relative to this directory. These files are copied
|
|
255 | 253 | # html_search_scorer = 'scorer.js'
|
256 | 254 |
|
257 | 255 | # Output file base name for HTML help builder.
|
258 |
| -htmlhelp_basename = 'Graphenedoc' |
| 256 | +htmlhelp_basename = "Graphenedoc" |
259 | 257 |
|
260 | 258 | # -- Options for LaTeX output ---------------------------------------------
|
261 | 259 |
|
262 | 260 | latex_elements = {
|
263 |
| - # The paper size ('letterpaper' or 'a4paper'). |
264 |
| - # |
265 |
| - # 'papersize': 'letterpaper', |
266 |
| - |
267 |
| - # The font size ('10pt', '11pt' or '12pt'). |
268 |
| - # |
269 |
| - # 'pointsize': '10pt', |
270 |
| - |
271 |
| - # Additional stuff for the LaTeX preamble. |
272 |
| - # |
273 |
| - # 'preamble': '', |
274 |
| - |
275 |
| - # Latex figure (float) alignment |
276 |
| - # |
277 |
| - # 'figure_align': 'htbp', |
| 261 | + # The paper size ('letterpaper' or 'a4paper'). |
| 262 | + # |
| 263 | + # 'papersize': 'letterpaper', |
| 264 | + # The font size ('10pt', '11pt' or '12pt'). |
| 265 | + # |
| 266 | + # 'pointsize': '10pt', |
| 267 | + # Additional stuff for the LaTeX preamble. |
| 268 | + # |
| 269 | + # 'preamble': '', |
| 270 | + # Latex figure (float) alignment |
| 271 | + # |
| 272 | + # 'figure_align': 'htbp', |
278 | 273 | }
|
279 | 274 |
|
280 | 275 | # Grouping the document tree into LaTeX files. List of tuples
|
281 | 276 | # (source start file, target name, title,
|
282 | 277 | # author, documentclass [howto, manual, or own class]).
|
283 | 278 | latex_documents = [
|
284 |
| - (master_doc, 'Graphene.tex', u'Graphene Documentation', |
285 |
| - u'Syrus Akbary', 'manual'), |
| 279 | + (master_doc, "Graphene.tex", u"Graphene Documentation", u"Syrus Akbary", "manual") |
286 | 280 | ]
|
287 | 281 |
|
288 | 282 | # The name of an image file (relative to this directory) to place at the top of
|
|
322 | 316 |
|
323 | 317 | # One entry per manual page. List of tuples
|
324 | 318 | # (source start file, name, description, authors, manual section).
|
325 |
| -man_pages = [ |
326 |
| - (master_doc, 'graphene', u'Graphene Documentation', |
327 |
| - [author], 1) |
328 |
| -] |
| 319 | +man_pages = [(master_doc, "graphene", u"Graphene Documentation", [author], 1)] |
329 | 320 |
|
330 | 321 | # If true, show URL addresses after external links.
|
331 | 322 | #
|
|
338 | 329 | # (source start file, target name, title, author,
|
339 | 330 | # dir menu entry, description, category)
|
340 | 331 | texinfo_documents = [
|
341 |
| - (master_doc, 'Graphene', u'Graphene Documentation', |
342 |
| - author, 'Graphene', 'One line description of project.', |
343 |
| - 'Miscellaneous'), |
| 332 | + ( |
| 333 | + master_doc, |
| 334 | + "Graphene", |
| 335 | + u"Graphene Documentation", |
| 336 | + author, |
| 337 | + "Graphene", |
| 338 | + "One line description of project.", |
| 339 | + "Miscellaneous", |
| 340 | + ) |
344 | 341 | ]
|
345 | 342 |
|
346 | 343 | # Documents to append as an appendix to all manuals.
|
|
414 | 411 | # epub_post_files = []
|
415 | 412 |
|
416 | 413 | # A list of files that should not be packed into the epub file.
|
417 |
| -epub_exclude_files = ['search.html'] |
| 414 | +epub_exclude_files = ["search.html"] |
418 | 415 |
|
419 | 416 | # The depth of the table of contents in toc.ncx.
|
420 | 417 | #
|
|
447 | 444 |
|
448 | 445 | # Example configuration for intersphinx: refer to the Python standard library.
|
449 | 446 | intersphinx_mapping = {
|
450 |
| - 'https://docs.python.org/': None, |
451 |
| - 'python': ('https://docs.python.org/', None), |
452 |
| - 'graphene_django': ('http://docs.graphene-python.org/projects/django/en/latest/', None), |
453 |
| - 'graphene_sqlalchemy': ('http://docs.graphene-python.org/projects/sqlalchemy/en/latest/', None), |
454 |
| - 'graphene_gae': ('http://docs.graphene-python.org/projects/gae/en/latest/', None), |
| 447 | + "https://docs.python.org/": None, |
| 448 | + "python": ("https://docs.python.org/", None), |
| 449 | + "graphene_django": ( |
| 450 | + "http://docs.graphene-python.org/projects/django/en/latest/", |
| 451 | + None, |
| 452 | + ), |
| 453 | + "graphene_sqlalchemy": ( |
| 454 | + "http://docs.graphene-python.org/projects/sqlalchemy/en/latest/", |
| 455 | + None, |
| 456 | + ), |
| 457 | + "graphene_gae": ("http://docs.graphene-python.org/projects/gae/en/latest/", None), |
455 | 458 | }
|
0 commit comments