1 # -*- coding: utf-8 -*-
3 # Ganeti documentation build configuration file, created by
4 # sphinx-quickstart on Tue Apr 14 13:23:20 2009.
6 # This file is execfile()d with the 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("."))
21 # -- General configuration -----------------------------------------------------
23 # If your documentation needs a minimal Sphinx version, state it here.
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.
30 "sphinx.ext.graphviz",
31 "ganeti.build.sphinx_ext",
32 "ganeti.build.shell_example_lexer",
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ["_templates"]
38 # The suffix of source filenames.
39 source_suffix = ".rst"
41 # The encoding of source files.
42 source_encoding = "utf-8"
44 # The master toctree document.
47 # General information about the project.
49 copyright = u"2006, 2007, 2008, 2009, 2010, 2011, 2012, Google Inc."
51 # The version info for the project you're documenting, acts as replacement for
52 # |version| and |release|, also used in various other places throughout the
55 # These next two will be passed via the command line, see the makefile
56 # The short X.Y version
57 #version = VERSION_MAJOR + "." + VERSION_MINOR
58 # The full version, including alpha/beta/rc tags.
59 #release = PACKAGE_VERSION
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = "%B %d, %Y"
71 # List of documents that shouldn't be included in the build.
74 # List of directories, relative to source directory, that shouldn't be searched
83 # The reST default role (used for this markup: `text`) to use for all documents.
86 # If true, "()" will be appended to :func: etc. cross-reference text.
87 #add_function_parentheses = True
89 # If true, the current module name will be prepended to all description
90 # unit titles (such as .. function::).
91 #add_module_names = True
93 # If true, sectionauthor and moduleauthor directives will be shown in the
94 # output. They are ignored by default.
97 # The name of the Pygments (syntax highlighting) style to use.
98 pygments_style = "sphinx"
100 # A list of ignored prefixes for module index sorting.
101 #modindex_common_prefix = []
104 # -- Options for HTML output ---------------------------------------------------
106 # The theme to use for HTML and HTML Help pages. See the documentation for
107 # a list of builtin themes.
108 html_theme = "default"
110 # Theme options are theme-specific and customize the look and feel of a theme
111 # further. For a list of options available for each theme, see the
113 #html_theme_options = {}
115 # Add any paths that contain custom themes here, relative to this directory.
116 #html_theme_path = []
118 # The name for this set of Sphinx documents. If None, it defaults to
119 # "<project> v<release> documentation".
122 # A shorter title for the navigation bar. Default is the same as html_title.
123 #html_short_title = None
125 # The name of an image file (relative to this directory) to place at the top
129 # The name of an image file (within the static path) to use as favicon of the
130 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 html_static_path = []
139 # If not "", a "Last updated on:" timestamp is inserted at every page bottom,
140 # using the given strftime format.
141 #html_last_updated_fmt = "%b %d, %Y"
143 # If true, SmartyPants will be used to convert quotes and dashes to
144 # typographically correct entities.
145 #html_use_smartypants = True
147 # Custom sidebar templates, maps document names to template names.
150 # Additional templates that should be rendered to pages, maps page names to
152 #html_additional_pages = {}
154 # If false, no module index is generated.
155 html_use_modindex = False
157 # If false, no index is generated.
158 html_use_index = False
160 # If true, the index is split into individual pages for each letter.
161 #html_split_index = False
163 # If true, links to the reST sources are added to the pages.
164 #html_show_sourcelink = True
166 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
167 #html_show_sphinx = True
169 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
170 #html_show_copyright = True
172 # If true, an OpenSearch description file will be output, and all pages will
173 # contain a <link> tag referring to it. The value of this option must be the
174 # base URL from which the finished HTML is served.
175 #html_use_opensearch = ""
177 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
178 #html_file_suffix = ""
180 # Output file base name for HTML help builder.
181 htmlhelp_basename = "Ganetidoc"
184 # -- Options for LaTeX output --------------------------------------------------
186 # The paper size ("letter" or "a4").
187 #latex_paper_size = "a4"
189 # The font size ("10pt", "11pt" or "12pt").
190 #latex_font_size = "10pt"
192 # Grouping the document tree into LaTeX files. List of tuples
193 # (source start file, target name, title, author, documentclass [howto/manual]).
195 ("index", "Ganeti.tex", u"Ganeti Documentation",
196 u"Google Inc.", "manual"),
199 # The name of an image file (relative to this directory) to place at the top of
203 # For "manual" documents, if this is true, then toplevel headings are parts,
205 #latex_use_parts = False
207 # If true, show page references after internal links.
208 #latex_show_pagerefs = False
210 # If true, show URL addresses after external links.
211 #latex_show_urls = False
213 # Additional stuff for the LaTeX preamble.
216 # Documents to append as an appendix to all manuals.
217 #latex_appendices = []
219 # If false, no module index is generated.
220 latex_use_modindex = False