|
21 | 21 | import os |
22 | 22 | import sys |
23 | 23 |
|
24 | | -sys.path.insert(0, os.path.abspath('..')) |
| 24 | +sys.path.insert(0, os.path.abspath("..")) |
25 | 25 | from hcloud.__version__ import VERSION # noqa |
26 | 26 |
|
27 | 27 | # -- General configuration --------------------------------------------- |
|
32 | 32 |
|
33 | 33 | # Add any Sphinx extension module names here, as strings. They can be |
34 | 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
35 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] |
| 35 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] |
36 | 36 |
|
37 | 37 | # Add any paths that contain templates here, relative to this directory. |
38 | | -templates_path = ['_templates'] |
| 38 | +templates_path = ["_templates"] |
39 | 39 |
|
40 | 40 | # The suffix(es) of source filenames. |
41 | 41 | # You can specify multiple suffix as a list of string: |
|
44 | 44 | # source_suffix = '.rst' |
45 | 45 |
|
46 | 46 | # The master toctree document. |
47 | | -master_doc = 'index' |
| 47 | +master_doc = "index" |
48 | 48 |
|
49 | 49 | # General information about the project. |
50 | | -project = u'Hetzner Cloud Python' |
| 50 | +project = u"Hetzner Cloud Python" |
51 | 51 | copyright = u"2019, Hetzner Cloud GmbH" |
52 | 52 | author = u"Hetzner Cloud GmbH" |
53 | 53 |
|
|
70 | 70 | # List of patterns, relative to source directory, that match files and |
71 | 71 | # directories to ignore when looking for source files. |
72 | 72 | # This patterns also effect to html_static_path and html_extra_path |
73 | | -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 73 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] |
74 | 74 |
|
75 | 75 | # The name of the Pygments (syntax highlighting) style to use. |
76 | | -pygments_style = 'sphinx' |
| 76 | +pygments_style = "sphinx" |
77 | 77 |
|
78 | 78 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
79 | 79 | todo_include_todos = False |
|
87 | 87 | # The theme to use for HTML and HTML Help pages. See the documentation for |
88 | 88 | # a list of builtin themes. |
89 | 89 | # |
90 | | -html_theme = 'sphinx_rtd_theme' |
91 | | -html_logo = '_static/logo-hetzner-online.svg' |
| 90 | +html_theme = "sphinx_rtd_theme" |
| 91 | +html_logo = "_static/logo-hetzner-online.svg" |
92 | 92 | # Theme options are theme-specific and customize the look and feel of a |
93 | 93 | # theme further. For a list of options available for each theme, see the |
94 | 94 | # documentation. |
95 | 95 | # |
96 | 96 | html_theme_options = { |
97 | | - 'logo_only': True, |
| 97 | + "logo_only": True, |
98 | 98 | } |
99 | 99 |
|
100 | 100 | # Add any paths that contain custom static files (such as style sheets) here, |
101 | 101 | # relative to this directory. They are copied after the builtin static files, |
102 | 102 | # so a file named "default.css" will overwrite the builtin "default.css". |
103 | | -html_static_path = ['_static'] |
| 103 | +html_static_path = ["_static"] |
104 | 104 |
|
105 | 105 | # -- Options for HTMLHelp output --------------------------------------- |
106 | 106 |
|
107 | 107 | # Output file base name for HTML help builder. |
108 | | -htmlhelp_basename = 'hclouddoc' |
| 108 | +htmlhelp_basename = "hclouddoc" |
109 | 109 |
|
110 | 110 | # -- Options for LaTeX output ------------------------------------------ |
111 | 111 |
|
112 | 112 | latex_elements = { |
113 | 113 | # The paper size ('letterpaper' or 'a4paper'). |
114 | 114 | # |
115 | 115 | # 'papersize': 'letterpaper', |
116 | | - |
117 | 116 | # The font size ('10pt', '11pt' or '12pt'). |
118 | 117 | # |
119 | 118 | # 'pointsize': '10pt', |
120 | | - |
121 | 119 | # Additional stuff for the LaTeX preamble. |
122 | 120 | # |
123 | 121 | # 'preamble': '', |
124 | | - |
125 | 122 | # Latex figure (float) alignment |
126 | 123 | # |
127 | 124 | # 'figure_align': 'htbp', |
|
131 | 128 | # (source start file, target name, title, author, documentclass |
132 | 129 | # [howto, manual, or own class]). |
133 | 130 | latex_documents = [ |
134 | | - (master_doc, 'hcloud.tex', |
135 | | - u'Hetzner Cloud Python Documentation', |
136 | | - u'Hetzner Cloud GmbH', 'manual'), |
| 131 | + ( |
| 132 | + master_doc, |
| 133 | + "hcloud.tex", |
| 134 | + u"Hetzner Cloud Python Documentation", |
| 135 | + u"Hetzner Cloud GmbH", |
| 136 | + "manual", |
| 137 | + ), |
137 | 138 | ] |
138 | 139 |
|
139 | 140 | # -- Options for manual page output ------------------------------------ |
140 | 141 |
|
141 | 142 | # One entry per manual page. List of tuples |
142 | 143 | # (source start file, name, description, authors, manual section). |
143 | | -man_pages = [ |
144 | | - (master_doc, |
145 | | - u'Hetzner Cloud Python Documentation', |
146 | | - [author], 1) |
147 | | -] |
| 144 | +man_pages = [(master_doc, u"Hetzner Cloud Python Documentation", [author], 1)] |
148 | 145 |
|
149 | 146 | # -- Options for Texinfo output ---------------------------------------- |
150 | 147 |
|
151 | 148 | # Grouping the document tree into Texinfo files. List of tuples |
152 | 149 | # (source start file, target name, title, author, |
153 | 150 | # dir menu entry, description, category) |
154 | 151 | texinfo_documents = [ |
155 | | - (master_doc, |
156 | | - u'Hetzner Cloud Python Documentation', |
157 | | - author, |
158 | | - 'HCloud-python is a library for the Hetzner Cloud API.', |
159 | | - 'Miscellaneous'), |
| 152 | + ( |
| 153 | + master_doc, |
| 154 | + u"Hetzner Cloud Python Documentation", |
| 155 | + author, |
| 156 | + "HCloud-python is a library for the Hetzner Cloud API.", |
| 157 | + "Miscellaneous", |
| 158 | + ), |
160 | 159 | ] |
161 | 160 |
|
162 | | -source_suffix = ['.rst'] |
| 161 | +source_suffix = [".rst"] |
0 commit comments