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