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