1
# -*- coding: utf-8 -*-
3
# python-cinderclient documentation build configuration file, created by
4
# sphinx-quickstart on Sun Dec 6 14:19:25 2009.
6
# This file is execfile()d with current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
16
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
#sys.path.append(os.path.abspath('.'))
20
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
21
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
22
sys.path.insert(0, ROOT)
24
# -- General configuration -----------------------------------------------------
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.intersphinx']
30
# Add any paths that contain templates here, relative to this directory.
31
templates_path = ['_templates']
33
# The suffix of source filenames.
34
source_suffix = '.rst'
36
# The encoding of source files.
37
#source_encoding = 'utf-8'
39
# The master toctree document.
42
# General information about the project.
43
project = u'python-cinderclient'
44
copyright = u'Rackspace, based on work by Jacob Kaplan-Moss'
46
# The version info for the project you're documenting, acts as replacement for
47
# |version| and |release|, also used in various other places throughout the
50
# The short X.Y version.
52
# The full version, including alpha/beta/rc tags.
55
# The language for content autogenerated by Sphinx. Refer to documentation
56
# for a list of supported languages.
59
# There are two options for replacing |today|: either, you set today to some
60
# non-false value, then it is used:
62
# Else, today_fmt is used as the format for a strftime call.
63
#today_fmt = '%B %d, %Y'
65
# List of documents that shouldn't be included in the build.
68
# List of directories, relative to source directory, that shouldn't be searched
72
# The reST default role (used for this markup: `text`) to use for all documents.
75
# If true, '()' will be appended to :func: etc. cross-reference text.
76
add_function_parentheses = True
78
# If true, the current module name will be prepended to all description
79
# unit titles (such as .. function::).
80
add_module_names = True
82
# If true, sectionauthor and moduleauthor directives will be shown in the
83
# output. They are ignored by default.
86
# The name of the Pygments (syntax highlighting) style to use.
87
pygments_style = 'sphinx'
89
# A list of ignored prefixes for module index sorting.
90
#modindex_common_prefix = []
93
# -- Options for HTML output ---------------------------------------------------
95
# The theme to use for HTML and HTML Help pages. Major themes that come with
96
# Sphinx are currently 'default' and 'sphinxdoc'.
99
# Theme options are theme-specific and customize the look and feel of a theme
100
# further. For a list of options available for each theme, see the
102
#html_theme_options = {}
104
# Add any paths that contain custom themes here, relative to this directory.
105
#html_theme_path = []
107
# The name for this set of Sphinx documents. If None, it defaults to
108
# "<project> v<release> documentation".
111
# A shorter title for the navigation bar. Default is the same as html_title.
112
#html_short_title = None
114
# The name of an image file (relative to this directory) to place at the top
118
# The name of an image file (within the static path) to use as favicon of the
119
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123
# Add any paths that contain custom static files (such as style sheets) here,
124
# relative to this directory. They are copied after the builtin static files,
125
# so a file named "default.css" will overwrite the builtin "default.css".
126
html_static_path = ['_static']
128
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129
# using the given strftime format.
130
#html_last_updated_fmt = '%b %d, %Y'
132
# If true, SmartyPants will be used to convert quotes and dashes to
133
# typographically correct entities.
134
#html_use_smartypants = True
136
# Custom sidebar templates, maps document names to template names.
139
# Additional templates that should be rendered to pages, maps page names to
141
#html_additional_pages = {}
143
# If false, no module index is generated.
144
#html_use_modindex = True
146
# If false, no index is generated.
147
#html_use_index = True
149
# If true, the index is split into individual pages for each letter.
150
#html_split_index = False
152
# If true, links to the reST sources are added to the pages.
153
#html_show_sourcelink = True
155
# If true, an OpenSearch description file will be output, and all pages will
156
# contain a <link> tag referring to it. The value of this option must be the
157
# base URL from which the finished HTML is served.
158
#html_use_opensearch = ''
160
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
161
#html_file_suffix = ''
163
# Output file base name for HTML help builder.
164
htmlhelp_basename = 'python-cinderclientdoc'
167
# -- Options for LaTeX output --------------------------------------------------
169
# The paper size ('letter' or 'a4').
170
#latex_paper_size = 'letter'
172
# The font size ('10pt', '11pt' or '12pt').
173
#latex_font_size = '10pt'
175
# Grouping the document tree into LaTeX files. List of tuples
176
# (source start file, target name, title, author, documentclass [howto/manual]).
178
('index', 'python-cinderclient.tex', u'python-cinderclient Documentation',
179
u'Rackspace - based on work by Jacob Kaplan-Moss', 'manual'),
182
# The name of an image file (relative to this directory) to place at the top of
186
# For "manual" documents, if this is true, then toplevel headings are parts,
188
#latex_use_parts = False
190
# Additional stuff for the LaTeX preamble.
193
# Documents to append as an appendix to all manuals.
194
#latex_appendices = []
196
# If false, no module index is generated.
197
#latex_use_modindex = True
200
# Example configuration for intersphinx: refer to the Python standard library.
201
intersphinx_mapping = {'http://docs.python.org/': None}
added
removed
doc/source/conf.py
