|
20 | 20 |
|
21 | 21 | import sphinx
|
22 | 22 |
|
23 |
| -sys.path.append('../') |
| 23 | +sys.path.append("../") |
24 | 24 | sys.path.append(os.path.dirname(__file__))
|
25 | 25 | import gitlab
|
26 | 26 |
|
27 |
| -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
| 27 | +on_rtd = os.environ.get("READTHEDOCS", None) == "True" |
28 | 28 |
|
29 | 29 | # If extensions (or modules to document with autodoc) are in another directory,
|
30 | 30 | # add these directories to sys.path here. If the directory is relative to the
|
31 | 31 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
32 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 32 | +sys.path.insert(0, os.path.abspath("..")) |
33 | 33 |
|
34 | 34 | # -- General configuration ------------------------------------------------
|
35 | 35 |
|
36 | 36 | # If your documentation needs a minimal Sphinx version, state it here.
|
37 |
| -#needs_sphinx = '1.0' |
| 37 | +# needs_sphinx = '1.0' |
38 | 38 |
|
39 | 39 | # Add any Sphinx extension module names here, as strings. They can be
|
40 | 40 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
41 | 41 | # ones.
|
42 |
| -extensions = [ |
43 |
| - 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'ext.docstrings' |
44 |
| -] |
| 42 | +extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "ext.docstrings"] |
45 | 43 |
|
46 | 44 | # Add any paths that contain templates here, relative to this directory.
|
47 |
| -templates_path = ['_templates'] |
| 45 | +templates_path = ["_templates"] |
48 | 46 |
|
49 | 47 | # The suffix of source filenames.
|
50 |
| -source_suffix = '.rst' |
| 48 | +source_suffix = ".rst" |
51 | 49 |
|
52 | 50 | # The encoding of source files.
|
53 |
| -#source_encoding = 'utf-8-sig' |
| 51 | +# source_encoding = 'utf-8-sig' |
54 | 52 |
|
55 | 53 | # The master toctree document.
|
56 |
| -master_doc = 'index' |
| 54 | +master_doc = "index" |
57 | 55 |
|
58 | 56 | # General information about the project.
|
59 |
| -project = 'python-gitlab' |
60 |
| -copyright = '2013-2018, Gauvain Pocentek, Mika Mäenpää' |
| 57 | +project = "python-gitlab" |
| 58 | +copyright = "2013-2018, Gauvain Pocentek, Mika Mäenpää" |
61 | 59 |
|
62 | 60 | # The version info for the project you're documenting, acts as replacement for
|
63 | 61 | # |version| and |release|, also used in various other places throughout the
|
|
70 | 68 |
|
71 | 69 | # The language for content autogenerated by Sphinx. Refer to documentation
|
72 | 70 | # for a list of supported languages.
|
73 |
| -#language = None |
| 71 | +# language = None |
74 | 72 |
|
75 | 73 | # There are two options for replacing |today|: either, you set today to some
|
76 | 74 | # non-false value, then it is used:
|
77 |
| -#today = '' |
| 75 | +# today = '' |
78 | 76 | # Else, today_fmt is used as the format for a strftime call.
|
79 |
| -#today_fmt = '%B %d, %Y' |
| 77 | +# today_fmt = '%B %d, %Y' |
80 | 78 |
|
81 | 79 | # List of patterns, relative to source directory, that match files and
|
82 | 80 | # directories to ignore when looking for source files.
|
83 |
| -exclude_patterns = ['_build'] |
| 81 | +exclude_patterns = ["_build"] |
84 | 82 |
|
85 | 83 | # The reST default role (used for this markup: `text`) to use for all
|
86 | 84 | # documents.
|
87 |
| -#default_role = None |
| 85 | +# default_role = None |
88 | 86 |
|
89 | 87 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
90 |
| -#add_function_parentheses = True |
| 88 | +# add_function_parentheses = True |
91 | 89 |
|
92 | 90 | # If true, the current module name will be prepended to all description
|
93 | 91 | # unit titles (such as .. function::).
|
94 |
| -#add_module_names = True |
| 92 | +# add_module_names = True |
95 | 93 |
|
96 | 94 | # If true, sectionauthor and moduleauthor directives will be shown in the
|
97 | 95 | # output. They are ignored by default.
|
98 |
| -#show_authors = False |
| 96 | +# show_authors = False |
99 | 97 |
|
100 | 98 | # The name of the Pygments (syntax highlighting) style to use.
|
101 |
| -pygments_style = 'sphinx' |
| 99 | +pygments_style = "sphinx" |
102 | 100 |
|
103 | 101 | # A list of ignored prefixes for module index sorting.
|
104 |
| -#modindex_common_prefix = [] |
| 102 | +# modindex_common_prefix = [] |
105 | 103 |
|
106 | 104 | # If true, keep warnings as "system message" paragraphs in the built documents.
|
107 |
| -#keep_warnings = False |
| 105 | +# keep_warnings = False |
108 | 106 |
|
109 | 107 |
|
110 | 108 | # -- Options for HTML output ----------------------------------------------
|
111 | 109 |
|
112 | 110 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
113 | 111 | # a list of builtin themes.
|
114 |
| -html_theme = 'default' |
115 |
| -if not on_rtd: # only import and set the theme if we're building docs locally |
| 112 | +html_theme = "default" |
| 113 | +if not on_rtd: # only import and set the theme if we're building docs locally |
116 | 114 | try:
|
117 | 115 | import sphinx_rtd_theme
|
118 |
| - html_theme = 'sphinx_rtd_theme' |
| 116 | + |
| 117 | + html_theme = "sphinx_rtd_theme" |
119 | 118 | html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
120 |
| - except ImportError: # Theme not found, use default |
| 119 | + except ImportError: # Theme not found, use default |
121 | 120 | pass
|
122 | 121 |
|
123 | 122 | # Theme options are theme-specific and customize the look and feel of a theme
|
124 | 123 | # further. For a list of options available for each theme, see the
|
125 | 124 | # documentation.
|
126 |
| -#html_theme_options = {} |
| 125 | +# html_theme_options = {} |
127 | 126 |
|
128 | 127 | # Add any paths that contain custom themes here, relative to this directory.
|
129 |
| -#html_theme_path = [] |
| 128 | +# html_theme_path = [] |
130 | 129 |
|
131 | 130 | # The name for this set of Sphinx documents. If None, it defaults to
|
132 | 131 | # "<project> v<release> documentation".
|
133 |
| -#html_title = None |
| 132 | +# html_title = None |
134 | 133 |
|
135 | 134 | # A shorter title for the navigation bar. Default is the same as html_title.
|
136 |
| -#html_short_title = None |
| 135 | +# html_short_title = None |
137 | 136 |
|
138 | 137 | # The name of an image file (relative to this directory) to place at the top
|
139 | 138 | # of the sidebar.
|
140 |
| -#html_logo = None |
| 139 | +# html_logo = None |
141 | 140 |
|
142 | 141 | # The name of an image file (within the static path) to use as favicon of the
|
143 | 142 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
144 | 143 | # pixels large.
|
145 |
| -#html_favicon = None |
| 144 | +# html_favicon = None |
146 | 145 |
|
147 | 146 | # Add any paths that contain custom static files (such as style sheets) here,
|
148 | 147 | # relative to this directory. They are copied after the builtin static files,
|
149 | 148 | # so a file named "default.css" will overwrite the builtin "default.css".
|
150 |
| -#html_static_path = ['_static'] |
| 149 | +# html_static_path = ['_static'] |
151 | 150 |
|
152 | 151 | # Add any extra paths that contain custom files (such as robots.txt or
|
153 | 152 | # .htaccess) here, relative to this directory. These files are copied
|
154 | 153 | # directly to the root of the documentation.
|
155 |
| -#html_extra_path = [] |
| 154 | +# html_extra_path = [] |
156 | 155 |
|
157 | 156 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
158 | 157 | # using the given strftime format.
|
159 |
| -#html_last_updated_fmt = '%b %d, %Y' |
| 158 | +# html_last_updated_fmt = '%b %d, %Y' |
160 | 159 |
|
161 | 160 | # If true, SmartyPants will be used to convert quotes and dashes to
|
162 | 161 | # typographically correct entities.
|
163 |
| -#html_use_smartypants = True |
| 162 | +# html_use_smartypants = True |
164 | 163 |
|
165 | 164 | # Custom sidebar templates, maps document names to template names.
|
166 |
| -#html_sidebars = {} |
| 165 | +# html_sidebars = {} |
167 | 166 |
|
168 | 167 | # Additional templates that should be rendered to pages, maps page names to
|
169 | 168 | # template names.
|
170 |
| -#html_additional_pages = {} |
| 169 | +# html_additional_pages = {} |
171 | 170 |
|
172 | 171 | # If false, no module index is generated.
|
173 |
| -#html_domain_indices = True |
| 172 | +# html_domain_indices = True |
174 | 173 |
|
175 | 174 | # If false, no index is generated.
|
176 |
| -#html_use_index = True |
| 175 | +# html_use_index = True |
177 | 176 |
|
178 | 177 | # If true, the index is split into individual pages for each letter.
|
179 |
| -#html_split_index = False |
| 178 | +# html_split_index = False |
180 | 179 |
|
181 | 180 | # If true, links to the reST sources are added to the pages.
|
182 |
| -#html_show_sourcelink = True |
| 181 | +# html_show_sourcelink = True |
183 | 182 |
|
184 | 183 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
185 |
| -#html_show_sphinx = True |
| 184 | +# html_show_sphinx = True |
186 | 185 |
|
187 | 186 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
188 |
| -#html_show_copyright = True |
| 187 | +# html_show_copyright = True |
189 | 188 |
|
190 | 189 | # If true, an OpenSearch description file will be output, and all pages will
|
191 | 190 | # contain a <link> tag referring to it. The value of this option must be the
|
192 | 191 | # base URL from which the finished HTML is served.
|
193 |
| -#html_use_opensearch = '' |
| 192 | +# html_use_opensearch = '' |
194 | 193 |
|
195 | 194 | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
196 |
| -#html_file_suffix = None |
| 195 | +# html_file_suffix = None |
197 | 196 |
|
198 | 197 | # Output file base name for HTML help builder.
|
199 |
| -htmlhelp_basename = 'python-gitlabdoc' |
| 198 | +htmlhelp_basename = "python-gitlabdoc" |
200 | 199 |
|
201 | 200 |
|
202 | 201 | # -- Options for LaTeX output ---------------------------------------------
|
203 | 202 |
|
204 | 203 | latex_elements = {
|
205 |
| -# The paper size ('letterpaper' or 'a4paper'). |
206 |
| -#'papersize': 'letterpaper', |
207 |
| - |
208 |
| -# The font size ('10pt', '11pt' or '12pt'). |
209 |
| -#'pointsize': '10pt', |
210 |
| - |
211 |
| -# Additional stuff for the LaTeX preamble. |
212 |
| -#'preamble': '', |
| 204 | + # The paper size ('letterpaper' or 'a4paper'). |
| 205 | + #'papersize': 'letterpaper', |
| 206 | + # The font size ('10pt', '11pt' or '12pt'). |
| 207 | + #'pointsize': '10pt', |
| 208 | + # Additional stuff for the LaTeX preamble. |
| 209 | + #'preamble': '', |
213 | 210 | }
|
214 | 211 |
|
215 | 212 | # Grouping the document tree into LaTeX files. List of tuples
|
216 | 213 | # (source start file, target name, title,
|
217 | 214 | # author, documentclass [howto, manual, or own class]).
|
218 | 215 | latex_documents = [
|
219 |
| - ('index', 'python-gitlab.tex', 'python-gitlab Documentation', |
220 |
| - 'Gauvain Pocentek, Mika Mäenpää', 'manual'), |
| 216 | + ( |
| 217 | + "index", |
| 218 | + "python-gitlab.tex", |
| 219 | + "python-gitlab Documentation", |
| 220 | + "Gauvain Pocentek, Mika Mäenpää", |
| 221 | + "manual", |
| 222 | + ) |
221 | 223 | ]
|
222 | 224 |
|
223 | 225 | # The name of an image file (relative to this directory) to place at the top of
|
224 | 226 | # the title page.
|
225 |
| -#latex_logo = None |
| 227 | +# latex_logo = None |
226 | 228 |
|
227 | 229 | # For "manual" documents, if this is true, then toplevel headings are parts,
|
228 | 230 | # not chapters.
|
229 |
| -#latex_use_parts = False |
| 231 | +# latex_use_parts = False |
230 | 232 |
|
231 | 233 | # If true, show page references after internal links.
|
232 |
| -#latex_show_pagerefs = False |
| 234 | +# latex_show_pagerefs = False |
233 | 235 |
|
234 | 236 | # If true, show URL addresses after external links.
|
235 |
| -#latex_show_urls = False |
| 237 | +# latex_show_urls = False |
236 | 238 |
|
237 | 239 | # Documents to append as an appendix to all manuals.
|
238 |
| -#latex_appendices = [] |
| 240 | +# latex_appendices = [] |
239 | 241 |
|
240 | 242 | # If false, no module index is generated.
|
241 |
| -#latex_domain_indices = True |
| 243 | +# latex_domain_indices = True |
242 | 244 |
|
243 | 245 |
|
244 | 246 | # -- Options for manual page output ---------------------------------------
|
245 | 247 |
|
246 | 248 | # One entry per manual page. List of tuples
|
247 | 249 | # (source start file, name, description, authors, manual section).
|
248 | 250 | man_pages = [
|
249 |
| - ('index', 'python-gitlab', 'python-gitlab Documentation', |
250 |
| - ['Gauvain Pocentek, Mika Mäenpää'], 1) |
| 251 | + ( |
| 252 | + "index", |
| 253 | + "python-gitlab", |
| 254 | + "python-gitlab Documentation", |
| 255 | + ["Gauvain Pocentek, Mika Mäenpää"], |
| 256 | + 1, |
| 257 | + ) |
251 | 258 | ]
|
252 | 259 |
|
253 | 260 | # If true, show URL addresses after external links.
|
254 |
| -#man_show_urls = False |
| 261 | +# man_show_urls = False |
255 | 262 |
|
256 | 263 |
|
257 | 264 | # -- Options for Texinfo output -------------------------------------------
|
|
260 | 267 | # (source start file, target name, title, author,
|
261 | 268 | # dir menu entry, description, category)
|
262 | 269 | texinfo_documents = [
|
263 |
| - ('index', 'python-gitlab', 'python-gitlab Documentation', |
264 |
| - 'Gauvain Pocentek, Mika Mäenpää', 'python-gitlab', 'One line description of project.', |
265 |
| - 'Miscellaneous'), |
| 270 | + ( |
| 271 | + "index", |
| 272 | + "python-gitlab", |
| 273 | + "python-gitlab Documentation", |
| 274 | + "Gauvain Pocentek, Mika Mäenpää", |
| 275 | + "python-gitlab", |
| 276 | + "One line description of project.", |
| 277 | + "Miscellaneous", |
| 278 | + ) |
266 | 279 | ]
|
267 | 280 |
|
268 | 281 | # Documents to append as an appendix to all manuals.
|
269 |
| -#texinfo_appendices = [] |
| 282 | +# texinfo_appendices = [] |
270 | 283 |
|
271 | 284 | # If false, no module index is generated.
|
272 |
| -#texinfo_domain_indices = True |
| 285 | +# texinfo_domain_indices = True |
273 | 286 |
|
274 | 287 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
275 |
| -#texinfo_show_urls = 'footnote' |
| 288 | +# texinfo_show_urls = 'footnote' |
276 | 289 |
|
277 | 290 | # If true, do not generate a @detailmenu in the "Top" node's menu.
|
278 |
| -#texinfo_no_detailmenu = False |
279 |
| - |
| 291 | +# texinfo_no_detailmenu = False |
0 commit comments