|
1 | | -# -*- coding: utf-8 -*- |
2 | | - |
3 | 1 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
4 | 2 | # not use this file except in compliance with the License. You may obtain |
5 | 3 | # a copy of the License at |
|
12 | 10 | # License for the specific language governing permissions and limitations |
13 | 11 | # under the License. |
14 | 12 |
|
15 | | -# python-cinderclient documentation build configuration file, created by |
16 | | -# sphinx-quickstart on Sun Dec 6 14:19:25 2009. |
17 | | -# |
18 | | -# This file is execfile()d with current directory set to its containing dir. |
19 | | -# |
20 | | -# Note that not all possible configuration values are present in this |
21 | | -# autogenerated file. |
22 | | -# |
23 | | -# All configuration values have a default; values that are commented out |
24 | | -# serve to show the default. |
| 13 | +# python-cinderclient documentation build configuration file |
25 | 14 |
|
26 | 15 | import os |
27 | 16 | import sys |
|
53 | 42 | # The suffix of source filenames. |
54 | 43 | source_suffix = '.rst' |
55 | 44 |
|
56 | | -# The encoding of source files. |
57 | | -# source_encoding = 'utf-8' |
58 | | - |
59 | 45 | # The master toctree document. |
60 | 46 | master_doc = 'index' |
61 | 47 |
|
|
72 | 58 | # The full version, including alpha/beta/rc tags. |
73 | 59 | release = version_info.release_string() |
74 | 60 |
|
75 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
76 | | -# for a list of supported languages. |
77 | | -# language = None |
78 | | - |
79 | | -# There are two options for replacing |today|: either, you set today to some |
80 | | -# non-false value, then it is used: |
81 | | -# today = '' |
82 | | -# Else, today_fmt is used as the format for a strftime call. |
83 | | -# today_fmt = '%B %d, %Y' |
84 | | - |
85 | | -# List of documents that shouldn't be included in the build. |
86 | | -# unused_docs = [] |
87 | | - |
88 | 61 | # List of directories, relative to source directory, that shouldn't be searched |
89 | 62 | # for source files. |
90 | 63 | exclude_trees = [] |
91 | 64 |
|
92 | | -# The reST default role (used for this markup: `text`) to use for all |
93 | | -# documents. |
94 | | -# default_role = None |
95 | | - |
96 | 65 | # If true, '()' will be appended to :func: etc. cross-reference text. |
97 | 66 | add_function_parentheses = True |
98 | 67 |
|
99 | 68 | # If true, the current module name will be prepended to all description |
100 | 69 | # unit titles (such as .. function::). |
101 | 70 | add_module_names = True |
102 | 71 |
|
103 | | -# If true, sectionauthor and moduleauthor directives will be shown in the |
104 | | -# output. They are ignored by default. |
105 | | -# show_authors = False |
106 | | - |
107 | 72 | # The name of the Pygments (syntax highlighting) style to use. |
108 | 73 | pygments_style = 'sphinx' |
109 | 74 |
|
110 | | -# A list of ignored prefixes for module index sorting. |
111 | | -# modindex_common_prefix = [] |
112 | | - |
113 | | - |
114 | | -man_pages = [ |
115 | | - ('cli/details', 'cinder', u'Client for OpenStack Block Storage API', |
116 | | - [u'OpenStack Contributors'], 1), |
117 | | -] |
118 | 75 | # -- Options for HTML output -------------------------------------------------- |
119 | 76 |
|
120 | 77 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
121 | 78 | # Sphinx are currently 'default' and 'sphinxdoc'. |
122 | 79 | # html_theme = 'nature' |
123 | 80 | html_theme = 'openstackdocs' |
124 | 81 |
|
125 | | -# Theme options are theme-specific and customize the look and feel of a theme |
126 | | -# further. For a list of options available for each theme, see the |
127 | | -# documentation. |
128 | | -# html_theme_options = {} |
129 | | - |
130 | | -# Add any paths that contain custom themes here, relative to this directory. |
131 | | -# html_theme_path = [] |
132 | | - |
133 | | -# The name for this set of Sphinx documents. If None, it defaults to |
134 | | -# "<project> v<release> documentation". |
135 | | -# html_title = None |
136 | | - |
137 | | -# A shorter title for the navigation bar. Default is the same as html_title. |
138 | | -# html_short_title = None |
139 | | - |
140 | | -# The name of an image file (relative to this directory) to place at the top |
141 | | -# of the sidebar. |
142 | | -# html_logo = None |
143 | | - |
144 | | -# The name of an image file (within the static path) to use as favicon of the |
145 | | -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
146 | | -# pixels large. |
147 | | -# html_favicon = None |
148 | | - |
149 | | -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
150 | | -# using the given strftime format. |
151 | | -# html_last_updated_fmt = '%b %d, %Y' |
152 | | - |
153 | | -# If true, SmartyPants will be used to convert quotes and dashes to |
154 | | -# typographically correct entities. |
155 | | -# html_use_smartypants = True |
156 | | - |
157 | | -# Custom sidebar templates, maps document names to template names. |
158 | | -# html_sidebars = {} |
159 | | - |
160 | | -# Additional templates that should be rendered to pages, maps page names to |
161 | | -# template names. |
162 | | -# html_additional_pages = {} |
163 | | - |
164 | | -# If false, no module index is generated. |
165 | | -# html_use_modindex = True |
166 | | - |
167 | | -# If false, no index is generated. |
168 | | -# html_use_index = True |
169 | | - |
170 | | -# If true, the index is split into individual pages for each letter. |
171 | | -# html_split_index = False |
172 | | - |
173 | | -# If true, links to the reST sources are added to the pages. |
174 | | -# html_show_sourcelink = True |
175 | | - |
176 | | -# If true, an OpenSearch description file will be output, and all pages will |
177 | | -# contain a <link> tag referring to it. The value of this option must be the |
178 | | -# base URL from which the finished HTML is served. |
179 | | -# html_use_opensearch = '' |
180 | | - |
181 | | -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
182 | | -# html_file_suffix = '' |
183 | | - |
184 | | -# Output file base name for HTML help builder. |
185 | | -htmlhelp_basename = 'python-cinderclientdoc' |
186 | | - |
187 | 82 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
188 | 83 | # using the given strftime format. |
189 | 84 | # html_last_updated_fmt = '%b %d, %Y' |
190 | 85 | html_last_updated_fmt = '%Y-%m-%d %H:%M' |
191 | 86 |
|
192 | | -# -- Options for LaTeX output ------------------------------------------------- |
| 87 | +# -- Options for manual page output ------------------------------------------ |
193 | 88 |
|
194 | | -# The paper size ('letter' or 'a4'). |
195 | | -# latex_paper_size = 'letter' |
196 | | - |
197 | | -# The font size ('10pt', '11pt' or '12pt'). |
198 | | -# latex_font_size = '10pt' |
199 | | - |
200 | | -# Grouping the document tree into LaTeX files. List of tuples |
201 | | -# (source start file, target name, title, author, documentclass [howto/manual]) |
202 | | -# . |
203 | | -latex_documents = [ |
204 | | - ('index', 'python-cinderclient.tex', 'python-cinderclient Documentation', |
205 | | - 'Rackspace - based on work by Jacob Kaplan-Moss', 'manual'), |
| 89 | +man_pages = [ |
| 90 | + ('cli/details', 'cinder', u'Client for OpenStack Block Storage API', |
| 91 | + [u'OpenStack Contributors'], 1), |
206 | 92 | ] |
207 | 93 |
|
208 | | -# The name of an image file (relative to this directory) to place at the top of |
209 | | -# the title page. |
210 | | -# latex_logo = None |
211 | | - |
212 | | -# For "manual" documents, if this is true, then toplevel headings are parts, |
213 | | -# not chapters. |
214 | | -# latex_use_parts = False |
215 | | - |
216 | | -# Additional stuff for the LaTeX preamble. |
217 | | -# latex_preamble = '' |
218 | | - |
219 | | -# Documents to append as an appendix to all manuals. |
220 | | -# latex_appendices = [] |
221 | | - |
222 | | -# If false, no module index is generated. |
223 | | -# latex_use_modindex = True |
224 | | - |
225 | 94 | # -- Options for openstackdocstheme ------------------------------------------- |
| 95 | + |
226 | 96 | repository_name = 'openstack/python-cinderclient' |
227 | 97 | bug_project = 'cinderclient' |
228 | 98 | bug_tag = '' |
0 commit comments