|
1 | 1 | # -*- coding: utf-8 -*- |
2 | 2 | # |
3 | | -# OpenStack Command Line Client documentation build configuration file, created by |
4 | | -# sphinx-quickstart on Wed May 16 12:05:58 2012. |
| 3 | +# OpenStack Command Line Client documentation build configuration file, created |
| 4 | +# by sphinx-quickstart on Wed May 16 12:05:58 2012. |
5 | 5 | # |
6 | | -# This file is execfile()d with the current directory set to its containing dir. |
| 6 | +# This file is execfile()d with the current directory set to its containing |
| 7 | +# dir. |
7 | 8 | # |
8 | 9 | # Note that not all possible configuration values are present in this |
9 | 10 | # autogenerated file. |
10 | 11 | # |
11 | 12 | # All configuration values have a default; values that are commented out |
12 | 13 | # serve to show the default. |
13 | 14 |
|
14 | | -import sys, os |
| 15 | +import os |
| 16 | +import sys |
15 | 17 |
|
16 | 18 | # If extensions (or modules to document with autodoc) are in another directory, |
17 | 19 | # add these directories to sys.path here. If the directory is relative to the |
18 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
19 | 21 | #sys.path.insert(0, os.path.abspath('.')) |
20 | 22 |
|
21 | | -# -- General configuration ----------------------------------------------------- |
| 23 | +# -- General configuration ---------------------------------------------------- |
22 | 24 |
|
23 | 25 | # If your documentation needs a minimal Sphinx version, state it here. |
24 | 26 | #needs_sphinx = '1.0' |
25 | 27 |
|
26 | | -# Add any Sphinx extension module names here, as strings. They can be extensions |
27 | | -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
28 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo'] |
| 28 | +# Add any Sphinx extension module names here, as strings. They can be |
| 29 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 30 | +extensions = ['sphinx.ext.autodoc', |
| 31 | + 'sphinx.ext.doctest', |
| 32 | + 'sphinx.ext.intersphinx', |
| 33 | + 'sphinx.ext.todo'] |
29 | 34 |
|
30 | 35 | # Add any paths that contain templates here, relative to this directory. |
31 | 36 | templates_path = ['_templates'] |
|
66 | 71 | # directories to ignore when looking for source files. |
67 | 72 | exclude_patterns = [] |
68 | 73 |
|
69 | | -# The reST default role (used for this markup: `text`) to use for all documents. |
| 74 | +# The reST default role (used for this markup: `text`) to use for all |
| 75 | +# documents. |
70 | 76 | #default_role = None |
71 | 77 |
|
72 | 78 | # If true, '()' will be appended to :func: etc. cross-reference text. |
|
87 | 93 | #modindex_common_prefix = [] |
88 | 94 |
|
89 | 95 |
|
90 | | -# -- Options for HTML output --------------------------------------------------- |
| 96 | +# -- Options for HTML output -------------------------------------------------- |
91 | 97 |
|
92 | 98 | # The theme to use for HTML and HTML Help pages. See the documentation for |
93 | 99 | # a list of builtin themes. |
|
167 | 173 | htmlhelp_basename = 'OpenStackCommandLineClientdoc' |
168 | 174 |
|
169 | 175 |
|
170 | | -# -- Options for LaTeX output -------------------------------------------------- |
| 176 | +# -- Options for LaTeX output ------------------------------------------------- |
171 | 177 |
|
172 | 178 | latex_elements = { |
173 | 179 | # The paper size ('letterpaper' or 'a4paper'). |
|
181 | 187 | } |
182 | 188 |
|
183 | 189 | # Grouping the document tree into LaTeX files. List of tuples |
184 | | -# (source start file, target name, title, author, documentclass [howto/manual]). |
| 190 | +# (source start file, target name, title, author, documentclass [howto/manual]) |
| 191 | +# . |
185 | 192 | latex_documents = [ |
186 | | - ('index', 'OpenStackCommandLineClient.tex', u'OpenStack Command Line Client Documentation', |
187 | | - u'OpenStack', 'manual'), |
| 193 | + ('index', 'OpenStackCommandLineClient.tex', |
| 194 | + u'OpenStack Command Line Client Documentation', |
| 195 | + u'OpenStack', 'manual'), |
188 | 196 | ] |
189 | 197 |
|
190 | 198 | # The name of an image file (relative to this directory) to place at the top of |
|
208 | 216 | #latex_domain_indices = True |
209 | 217 |
|
210 | 218 |
|
211 | | -# -- Options for manual page output -------------------------------------------- |
| 219 | +# -- Options for manual page output ------------------------------------------- |
212 | 220 |
|
213 | 221 | # One entry per manual page. List of tuples |
214 | 222 | # (source start file, name, description, authors, manual section). |
215 | 223 | man_pages = [ |
216 | | - ('index', 'openstackcommandlineclient', u'OpenStack Command Line Client Documentation', |
| 224 | + ('index', 'openstackcommandlineclient', |
| 225 | + u'OpenStack Command Line Client Documentation', |
217 | 226 | [u'OpenStack'], 1) |
218 | 227 | ] |
219 | 228 |
|
220 | 229 | # If true, show URL addresses after external links. |
221 | 230 | #man_show_urls = False |
222 | 231 |
|
223 | 232 |
|
224 | | -# -- Options for Texinfo output ------------------------------------------------ |
| 233 | +# -- Options for Texinfo output ----------------------------------------------- |
225 | 234 |
|
226 | 235 | # Grouping the document tree into Texinfo files. List of tuples |
227 | 236 | # (source start file, target name, title, author, |
228 | 237 | # dir menu entry, description, category) |
229 | 238 | texinfo_documents = [ |
230 | | - ('index', 'OpenStackCommandLineClient', u'OpenStack Command Line Client Documentation', |
231 | | - u'OpenStack', 'OpenStackCommandLineClient', 'One line description of project.', |
232 | | - 'Miscellaneous'), |
| 239 | + ('index', 'OpenStackCommandLineClient', |
| 240 | + u'OpenStack Command Line Client Documentation', |
| 241 | + u'OpenStack', 'OpenStackCommandLineClient', |
| 242 | + 'One line description of project.', |
| 243 | + 'Miscellaneous'), |
233 | 244 | ] |
234 | 245 |
|
235 | 246 | # Documents to append as an appendix to all manuals. |
|
0 commit comments