root / doc / conf.py @ 7bd8ce44
History | View | Annotate | Download (7 kB)
1 |
# -*- coding: utf-8 -*-
|
---|---|
2 |
#
|
3 |
# Ganeti documentation build configuration file, created by
|
4 |
# sphinx-quickstart on Tue Apr 14 13:23:20 2009.
|
5 |
#
|
6 |
# This file is execfile()d with the current directory set to its containing dir.
|
7 |
#
|
8 |
# Note that not all possible configuration values are present in this
|
9 |
# autogenerated file.
|
10 |
#
|
11 |
# All configuration values have a default; values that are commented out
|
12 |
# serve to show the default.
|
13 |
|
14 |
import sys, os |
15 |
|
16 |
enable_manpages = bool(os.getenv("ENABLE_MANPAGES")) |
17 |
|
18 |
# If extensions (or modules to document with autodoc) are in another directory,
|
19 |
# add these directories to sys.path here. If the directory is relative to the
|
20 |
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
21 |
#sys.path.append(os.path.abspath("."))
|
22 |
|
23 |
# -- General configuration -----------------------------------------------------
|
24 |
|
25 |
# If your documentation needs a minimal Sphinx version, state it here.
|
26 |
needs_sphinx = "1.0"
|
27 |
|
28 |
# Add any Sphinx extension module names here, as strings. They can be extensions
|
29 |
# coming with Sphinx (named "sphinx.ext.*") or your custom ones.
|
30 |
extensions = [ |
31 |
"sphinx.ext.todo",
|
32 |
"sphinx.ext.graphviz",
|
33 |
"ganeti.build.sphinx_ext",
|
34 |
"ganeti.build.shell_example_lexer",
|
35 |
] |
36 |
|
37 |
# Add any paths that contain templates here, relative to this directory.
|
38 |
templates_path = ["_templates"]
|
39 |
|
40 |
# The suffix of source filenames.
|
41 |
source_suffix = ".rst"
|
42 |
|
43 |
# The encoding of source files.
|
44 |
source_encoding = "utf-8"
|
45 |
|
46 |
# The master toctree document.
|
47 |
master_doc = "index"
|
48 |
|
49 |
# General information about the project.
|
50 |
project = u"Ganeti"
|
51 |
copyright = u"%s Google Inc." % ", ".join(map(str, range(2006, 2013 + 1))) |
52 |
|
53 |
# The version info for the project you're documenting, acts as replacement for
|
54 |
# |version| and |release|, also used in various other places throughout the
|
55 |
# built documents.
|
56 |
#
|
57 |
# These next two will be passed via the command line, see the makefile
|
58 |
# The short X.Y version
|
59 |
#version = VERSION_MAJOR + "." + VERSION_MINOR
|
60 |
# The full version, including alpha/beta/rc tags.
|
61 |
#release = PACKAGE_VERSION
|
62 |
|
63 |
# The language for content autogenerated by Sphinx. Refer to documentation
|
64 |
# for a list of supported languages.
|
65 |
language = "en"
|
66 |
|
67 |
# There are two options for replacing |today|: either, you set today to some
|
68 |
# non-false value, then it is used:
|
69 |
#today = ""
|
70 |
# Else, today_fmt is used as the format for a strftime call.
|
71 |
#today_fmt = "%B %d, %Y"
|
72 |
|
73 |
# List of documents that shouldn't be included in the build.
|
74 |
#unused_docs = []
|
75 |
|
76 |
if enable_manpages:
|
77 |
exclude_patterns = [] |
78 |
else:
|
79 |
exclude_patterns = [ |
80 |
"man-*.rst",
|
81 |
] |
82 |
|
83 |
# List of directories, relative to source directory, that shouldn't be searched
|
84 |
# for source files.
|
85 |
exclude_trees = [ |
86 |
"_build",
|
87 |
"api",
|
88 |
"coverage"
|
89 |
"examples",
|
90 |
] |
91 |
|
92 |
# The reST default role (used for this markup: `text`) to use for all documents.
|
93 |
#default_role = None
|
94 |
|
95 |
# If true, "()" will be appended to :func: etc. cross-reference text.
|
96 |
#add_function_parentheses = True
|
97 |
|
98 |
# If true, the current module name will be prepended to all description
|
99 |
# unit titles (such as .. function::).
|
100 |
#add_module_names = True
|
101 |
|
102 |
# If true, sectionauthor and moduleauthor directives will be shown in the
|
103 |
# output. They are ignored by default.
|
104 |
#show_authors = False
|
105 |
|
106 |
# The name of the Pygments (syntax highlighting) style to use.
|
107 |
pygments_style = "sphinx"
|
108 |
|
109 |
# A list of ignored prefixes for module index sorting.
|
110 |
#modindex_common_prefix = []
|
111 |
|
112 |
|
113 |
# -- Options for HTML output ---------------------------------------------------
|
114 |
|
115 |
# The theme to use for HTML and HTML Help pages. See the documentation for
|
116 |
# a list of builtin themes.
|
117 |
html_theme = "default"
|
118 |
|
119 |
# Theme options are theme-specific and customize the look and feel of a theme
|
120 |
# further. For a list of options available for each theme, see the
|
121 |
# documentation.
|
122 |
#html_theme_options = {}
|
123 |
|
124 |
# Add any paths that contain custom themes here, relative to this directory.
|
125 |
#html_theme_path = []
|
126 |
|
127 |
# The name for this set of Sphinx documents. If None, it defaults to
|
128 |
# "<project> v<release> documentation".
|
129 |
#html_title = None
|
130 |
|
131 |
# A shorter title for the navigation bar. Default is the same as html_title.
|
132 |
#html_short_title = None
|
133 |
|
134 |
# The name of an image file (relative to this directory) to place at the top
|
135 |
# of the sidebar.
|
136 |
#html_logo = None
|
137 |
|
138 |
# The name of an image file (within the static path) to use as favicon of the
|
139 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
140 |
# pixels large.
|
141 |
#html_favicon = None
|
142 |
|
143 |
# Add any paths that contain custom static files (such as style sheets) here,
|
144 |
# relative to this directory. They are copied after the builtin static files,
|
145 |
# so a file named "default.css" will overwrite the builtin "default.css".
|
146 |
html_static_path = ["css"]
|
147 |
|
148 |
html_style = "style.css"
|
149 |
|
150 |
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
|
151 |
# using the given strftime format.
|
152 |
#html_last_updated_fmt = "%b %d, %Y"
|
153 |
|
154 |
# If true, SmartyPants will be used to convert quotes and dashes to
|
155 |
# typographically correct entities.
|
156 |
#html_use_smartypants = True
|
157 |
|
158 |
# Custom sidebar templates, maps document names to template names.
|
159 |
#html_sidebars = {}
|
160 |
|
161 |
# Additional templates that should be rendered to pages, maps page names to
|
162 |
# template names.
|
163 |
#html_additional_pages = {}
|
164 |
|
165 |
# If false, no module index is generated.
|
166 |
html_use_modindex = False
|
167 |
|
168 |
# If false, no index is generated.
|
169 |
html_use_index = False
|
170 |
|
171 |
# If true, the index is split into individual pages for each letter.
|
172 |
#html_split_index = False
|
173 |
|
174 |
# If true, links to the reST sources are added to the pages.
|
175 |
#html_show_sourcelink = True
|
176 |
|
177 |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
178 |
#html_show_sphinx = True
|
179 |
|
180 |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
181 |
#html_show_copyright = True
|
182 |
|
183 |
# If true, an OpenSearch description file will be output, and all pages will
|
184 |
# contain a <link> tag referring to it. The value of this option must be the
|
185 |
# base URL from which the finished HTML is served.
|
186 |
#html_use_opensearch = ""
|
187 |
|
188 |
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
189 |
#html_file_suffix = ""
|
190 |
|
191 |
# Output file base name for HTML help builder.
|
192 |
htmlhelp_basename = "Ganetidoc"
|
193 |
|
194 |
|
195 |
# -- Options for LaTeX output --------------------------------------------------
|
196 |
|
197 |
# The paper size ("letter" or "a4").
|
198 |
#latex_paper_size = "a4"
|
199 |
|
200 |
# The font size ("10pt", "11pt" or "12pt").
|
201 |
#latex_font_size = "10pt"
|
202 |
|
203 |
# Grouping the document tree into LaTeX files. List of tuples
|
204 |
# (source start file, target name, title, author, documentclass [howto/manual]).
|
205 |
latex_documents = [ |
206 |
("index", "Ganeti.tex", u"Ganeti Documentation", |
207 |
u"Google Inc.", "manual"), |
208 |
] |
209 |
|
210 |
# The name of an image file (relative to this directory) to place at the top of
|
211 |
# the title page.
|
212 |
#latex_logo = None
|
213 |
|
214 |
# For "manual" documents, if this is true, then toplevel headings are parts,
|
215 |
# not chapters.
|
216 |
#latex_use_parts = False
|
217 |
|
218 |
# If true, show page references after internal links.
|
219 |
#latex_show_pagerefs = False
|
220 |
|
221 |
# If true, show URL addresses after external links.
|
222 |
#latex_show_urls = False
|
223 |
|
224 |
# Additional stuff for the LaTeX preamble.
|
225 |
#latex_preamble = ""
|
226 |
|
227 |
# Documents to append as an appendix to all manuals.
|
228 |
#latex_appendices = []
|
229 |
|
230 |
# If false, no module index is generated.
|
231 |
latex_use_modindex = False
|