|
15 | 15 | # -- General configuration ---------------------------------------------------- |
16 | 16 |
|
17 | 17 | # If your documentation needs a minimal Sphinx version, state it here. |
18 | | -#needs_sphinx = '1.0' |
| 18 | +# needs_sphinx = '1.0' |
19 | 19 |
|
20 | 20 | # Add any Sphinx extension module names here, as strings. They can be |
21 | 21 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
22 | | -extensions = ['sphinx.ext.autodoc', |
23 | | - 'sphinx.ext.doctest', |
24 | | - 'sphinx.ext.todo', |
25 | | - 'openstackdocstheme', |
26 | | - 'stevedore.sphinxext', |
27 | | - 'cliff.sphinxext', |
28 | | - 'sphinxcontrib.apidoc', |
29 | | - ] |
| 22 | +extensions = [ |
| 23 | + 'sphinx.ext.autodoc', |
| 24 | + 'sphinx.ext.doctest', |
| 25 | + 'sphinx.ext.todo', |
| 26 | + 'openstackdocstheme', |
| 27 | + 'stevedore.sphinxext', |
| 28 | + 'cliff.sphinxext', |
| 29 | + 'sphinxcontrib.apidoc', |
| 30 | +] |
30 | 31 |
|
31 | 32 | # openstackdocstheme options |
32 | 33 | openstackdocs_repo_name = 'openstack/python-openstackclient' |
|
39 | 40 | ] |
40 | 41 |
|
41 | 42 | # Add any paths that contain templates here, relative to this directory. |
42 | | -#templates_path = ['_templates'] |
| 43 | +# templates_path = ['_templates'] |
43 | 44 |
|
44 | 45 | # The suffix of source filenames. |
45 | 46 | source_suffix = '.rst' |
46 | 47 |
|
47 | 48 | # The encoding of source files. |
48 | | -#source_encoding = 'utf-8-sig' |
| 49 | +# source_encoding = 'utf-8-sig' |
49 | 50 |
|
50 | 51 | # The master toctree document. |
51 | 52 | master_doc = 'index' |
|
56 | 57 |
|
57 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation |
58 | 59 | # for a list of supported languages. |
59 | | -#language = None |
| 60 | +# language = None |
60 | 61 |
|
61 | 62 | # There are two options for replacing |today|: either, you set today to some |
62 | 63 | # non-false value, then it is used: |
63 | | -#today = '' |
| 64 | +# today = '' |
64 | 65 | # Else, today_fmt is used as the format for a strftime call. |
65 | | -#today_fmt = '%B %d, %Y' |
| 66 | +# today_fmt = '%B %d, %Y' |
66 | 67 |
|
67 | 68 | # List of patterns, relative to source directory, that match files and |
68 | 69 | # directories to ignore when looking for source files. |
69 | 70 | exclude_patterns = ['**tests**'] |
70 | 71 |
|
71 | 72 | # The reST default role (used for this markup: `text`) to use for all |
72 | 73 | # documents. |
73 | | -#default_role = None |
| 74 | +# default_role = None |
74 | 75 |
|
75 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. |
76 | | -#add_function_parentheses = True |
| 77 | +# add_function_parentheses = True |
77 | 78 |
|
78 | 79 | # If true, the current module name will be prepended to all description |
79 | 80 | # unit titles (such as .. function::). |
80 | | -#add_module_names = True |
| 81 | +# add_module_names = True |
81 | 82 |
|
82 | 83 | # If true, sectionauthor and moduleauthor directives will be shown in the |
83 | 84 | # output. They are ignored by default. |
84 | | -#show_authors = False |
| 85 | +# show_authors = False |
85 | 86 |
|
86 | 87 | # The name of the Pygments (syntax highlighting) style to use. |
87 | 88 | pygments_style = 'native' |
|
94 | 95 |
|
95 | 96 | # The theme to use for HTML and HTML Help pages. See the documentation for |
96 | 97 | # a list of builtin themes. |
97 | | -#html_theme_path = ["."] |
98 | | -#html_theme = '_theme' |
| 98 | +# html_theme_path = ["."] |
| 99 | +# html_theme = '_theme' |
99 | 100 | html_theme = 'openstackdocs' |
100 | 101 |
|
101 | 102 | # Theme options are theme-specific and customize the look and feel of a theme |
102 | 103 | # further. For a list of options available for each theme, see the |
103 | 104 | # documentation. |
104 | | -#html_theme_options = {} |
| 105 | +# html_theme_options = {} |
105 | 106 |
|
106 | 107 | # Add any paths that contain custom themes here, relative to this directory. |
107 | | -#html_theme_path = [] |
| 108 | +# html_theme_path = [] |
108 | 109 |
|
109 | 110 | # The name for this set of Sphinx documents. If None, it defaults to |
110 | 111 | # "<project> v<release> documentation". |
111 | | -#html_title = None |
| 112 | +# html_title = None |
112 | 113 |
|
113 | 114 | # A shorter title for the navigation bar. Default is the same as html_title. |
114 | | -#html_short_title = None |
| 115 | +# html_short_title = None |
115 | 116 |
|
116 | 117 | # The name of an image file (relative to this directory) to place at the top |
117 | 118 | # of the sidebar. |
118 | | -#html_logo = None |
| 119 | +# html_logo = None |
119 | 120 |
|
120 | 121 | # The name of an image file (within the static path) to use as favicon of the |
121 | 122 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
122 | 123 | # pixels large. |
123 | | -#html_favicon = None |
| 124 | +# html_favicon = None |
124 | 125 |
|
125 | 126 | # Add any paths that contain custom static files (such as style sheets) here, |
126 | 127 | # relative to this directory. They are copied after the builtin static files, |
127 | 128 | # so a file named "default.css" will overwrite the builtin "default.css". |
128 | | -#html_static_path = ['_static'] |
| 129 | +# html_static_path = ['_static'] |
129 | 130 |
|
130 | 131 | # If true, SmartyPants will be used to convert quotes and dashes to |
131 | 132 | # typographically correct entities. |
132 | | -#html_use_smartypants = True |
| 133 | +# html_use_smartypants = True |
133 | 134 |
|
134 | 135 | # Custom sidebar templates, maps document names to template names. |
135 | | -#html_sidebars = {} |
| 136 | +# html_sidebars = {} |
136 | 137 |
|
137 | 138 | # Additional templates that should be rendered to pages, maps page names to |
138 | 139 | # template names. |
139 | | -#html_additional_pages = {} |
| 140 | +# html_additional_pages = {} |
140 | 141 |
|
141 | 142 | # If false, no module index is generated. |
142 | | -#html_domain_indices = True |
| 143 | +# html_domain_indices = True |
143 | 144 |
|
144 | 145 | # If false, no index is generated. |
145 | | -#html_use_index = True |
| 146 | +# html_use_index = True |
146 | 147 |
|
147 | 148 | # If true, the index is split into individual pages for each letter. |
148 | | -#html_split_index = False |
| 149 | +# html_split_index = False |
149 | 150 |
|
150 | 151 | # If true, links to the reST sources are added to the pages. |
151 | | -#html_show_sourcelink = True |
| 152 | +# html_show_sourcelink = True |
152 | 153 |
|
153 | 154 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
154 | | -#html_show_sphinx = True |
| 155 | +# html_show_sphinx = True |
155 | 156 |
|
156 | 157 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
157 | | -#html_show_copyright = True |
| 158 | +# html_show_copyright = True |
158 | 159 |
|
159 | 160 | # If true, an OpenSearch description file will be output, and all pages will |
160 | 161 | # contain a <link> tag referring to it. The value of this option must be the |
161 | 162 | # base URL from which the finished HTML is served. |
162 | | -#html_use_opensearch = '' |
| 163 | +# html_use_opensearch = '' |
163 | 164 |
|
164 | 165 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
165 | | -#html_file_suffix = None |
| 166 | +# html_file_suffix = None |
166 | 167 |
|
167 | 168 | # Output file base name for HTML help builder. |
168 | 169 | htmlhelp_basename = 'OpenStackCommandLineClientdoc' |
|
174 | 175 | # -- Options for LaTeX output ------------------------------------------------- |
175 | 176 |
|
176 | 177 | latex_elements = { |
177 | | -# The paper size ('letterpaper' or 'a4paper'). |
178 | | -#'papersize': 'letterpaper', |
179 | | - |
180 | | -# The font size ('10pt', '11pt' or '12pt'). |
181 | | -#'pointsize': '10pt', |
182 | | - |
183 | | -# Additional stuff for the LaTeX preamble. |
184 | | -#'preamble': '', |
| 178 | + # The paper size ('letterpaper' or 'a4paper'). |
| 179 | + #'papersize': 'letterpaper', |
| 180 | + # The font size ('10pt', '11pt' or '12pt'). |
| 181 | + #'pointsize': '10pt', |
| 182 | + # Additional stuff for the LaTeX preamble. |
| 183 | + #'preamble': '', |
185 | 184 | } |
186 | 185 |
|
187 | 186 | # Grouping the document tree into LaTeX files. List of tuples |
188 | 187 | # (source start file, target name, title, author, documentclass [howto/manual]) |
189 | 188 | # . |
190 | 189 | latex_documents = [ |
191 | | - ('index', 'OpenStackCommandLineClient.tex', |
192 | | - 'OpenStack Command Line Client Documentation', |
193 | | - 'OpenStack', 'manual'), |
| 190 | + ( |
| 191 | + 'index', |
| 192 | + 'OpenStackCommandLineClient.tex', |
| 193 | + 'OpenStack Command Line Client Documentation', |
| 194 | + 'OpenStack', |
| 195 | + 'manual', |
| 196 | + ), |
194 | 197 | ] |
195 | 198 |
|
196 | 199 | # The name of an image file (relative to this directory) to place at the top of |
197 | 200 | # the title page. |
198 | | -#latex_logo = None |
| 201 | +# latex_logo = None |
199 | 202 |
|
200 | 203 | # For "manual" documents, if this is true, then toplevel headings are parts, |
201 | 204 | # not chapters. |
202 | | -#latex_use_parts = False |
| 205 | +# latex_use_parts = False |
203 | 206 |
|
204 | 207 | # If true, show page references after internal links. |
205 | | -#latex_show_pagerefs = False |
| 208 | +# latex_show_pagerefs = False |
206 | 209 |
|
207 | 210 | # If true, show URL addresses after external links. |
208 | | -#latex_show_urls = False |
| 211 | +# latex_show_urls = False |
209 | 212 |
|
210 | 213 | # Documents to append as an appendix to all manuals. |
211 | | -#latex_appendices = [] |
| 214 | +# latex_appendices = [] |
212 | 215 |
|
213 | 216 | # If false, no module index is generated. |
214 | | -#latex_domain_indices = True |
| 217 | +# latex_domain_indices = True |
215 | 218 |
|
216 | 219 |
|
217 | 220 | # -- Options for manual page output ------------------------------------------- |
|
229 | 232 | ] |
230 | 233 |
|
231 | 234 | # If true, show URL addresses after external links. |
232 | | -#man_show_urls = False |
| 235 | +# man_show_urls = False |
233 | 236 |
|
234 | 237 |
|
235 | 238 | # -- Options for Texinfo output ----------------------------------------------- |
|
238 | 241 | # (source start file, target name, title, author, |
239 | 242 | # dir menu entry, description, category) |
240 | 243 | texinfo_documents = [ |
241 | | - ('index', 'OpenStackCommandLineClient', |
242 | | - 'OpenStack Command Line Client Documentation', |
243 | | - 'OpenStack', 'OpenStackCommandLineClient', |
244 | | - 'One line description of project.', |
245 | | - 'Miscellaneous'), |
| 244 | + ( |
| 245 | + 'index', |
| 246 | + 'OpenStackCommandLineClient', |
| 247 | + 'OpenStack Command Line Client Documentation', |
| 248 | + 'OpenStack', |
| 249 | + 'OpenStackCommandLineClient', |
| 250 | + 'One line description of project.', |
| 251 | + 'Miscellaneous', |
| 252 | + ), |
246 | 253 | ] |
247 | 254 |
|
248 | 255 | # Documents to append as an appendix to all manuals. |
249 | | -#texinfo_appendices = [] |
| 256 | +# texinfo_appendices = [] |
250 | 257 |
|
251 | 258 | # If false, no module index is generated. |
252 | | -#texinfo_domain_indices = True |
| 259 | +# texinfo_domain_indices = True |
253 | 260 |
|
254 | 261 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
255 | | -#texinfo_show_urls = 'footnote' |
| 262 | +# texinfo_show_urls = 'footnote' |
256 | 263 |
|
257 | 264 |
|
258 | 265 | # -- Options for cliff.sphinxext plugin --------------------------------------- |
259 | 266 |
|
260 | 267 | autoprogram_cliff_application = 'openstack' |
261 | 268 |
|
262 | 269 | autoprogram_cliff_ignored = [ |
263 | | - '--help', '--format', '--column', '--max-width', '--fit-width', |
264 | | - '--print-empty', '--prefix', '--noindent', '--quote'] |
| 270 | + '--help', |
| 271 | + '--format', |
| 272 | + '--column', |
| 273 | + '--max-width', |
| 274 | + '--fit-width', |
| 275 | + '--print-empty', |
| 276 | + '--prefix', |
| 277 | + '--noindent', |
| 278 | + '--quote', |
| 279 | +] |
265 | 280 |
|
266 | 281 | # Prevent cliff from generating "This command is provided by the |
267 | 282 | # python-openstackclient plugin." |
|
0 commit comments