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",
34 # Add any paths that contain templates here, relative to this directory.
35 templates_path = ["_templates"]
37 # The suffix of source filenames.
38 source_suffix = ".rst"
40 # The encoding of source files.
41 source_encoding = "utf-8"
43 # The master toctree document.
46 # General information about the project.
48 copyright = u"2006, 2007, 2008, 2009, 2010, 2011, Google Inc."
50 # The version info for the project you're documenting, acts as replacement for
51 # |version| and |release|, also used in various other places throughout the
54 # These next two will be passed via the command line, see the makefile
55 # The short X.Y version
56 #version = VERSION_MAJOR + "." + VERSION_MINOR
57 # The full version, including alpha/beta/rc tags.
58 #release = PACKAGE_VERSION
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
64 # There are two options for replacing |today|: either, you set today to some
65 # non-false value, then it is used:
67 # Else, today_fmt is used as the format for a strftime call.
68 #today_fmt = "%B %d, %Y"
70 # List of documents that shouldn't be included in the build.
73 # List of directories, relative to source directory, that shouldn't be searched
82 # The reST default role (used for this markup: `text`) to use for all documents.
85 # If true, "()" will be appended to :func: etc. cross-reference text.
86 #add_function_parentheses = True
88 # If true, the current module name will be prepended to all description
89 # unit titles (such as .. function::).
90 #add_module_names = True
92 # If true, sectionauthor and moduleauthor directives will be shown in the
93 # output. They are ignored by default.
96 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = "sphinx"
99 # A list of ignored prefixes for module index sorting.
100 #modindex_common_prefix = []
103 # -- Options for HTML output ---------------------------------------------------
105 # The theme to use for HTML and HTML Help pages. See the documentation for
106 # a list of builtin themes.
107 html_theme = "default"
109 # Theme options are theme-specific and customize the look and feel of a theme
110 # further. For a list of options available for each theme, see the
112 #html_theme_options = {}
114 # Add any paths that contain custom themes here, relative to this directory.
115 #html_theme_path = []
117 # The name for this set of Sphinx documents. If None, it defaults to
118 # "<project> v<release> documentation".
121 # A shorter title for the navigation bar. Default is the same as html_title.
122 #html_short_title = None
124 # The name of an image file (relative to this directory) to place at the top
128 # The name of an image file (within the static path) to use as favicon of the
129 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
133 # Add any paths that contain custom static files (such as style sheets) here,
134 # relative to this directory. They are copied after the builtin static files,
135 # so a file named "default.css" will overwrite the builtin "default.css".
136 html_static_path = []
138 # If not "", a "Last updated on:" timestamp is inserted at every page bottom,
139 # using the given strftime format.
140 #html_last_updated_fmt = "%b %d, %Y"
142 # If true, SmartyPants will be used to convert quotes and dashes to
143 # typographically correct entities.
144 #html_use_smartypants = True
146 # Custom sidebar templates, maps document names to template names.
149 # Additional templates that should be rendered to pages, maps page names to
151 #html_additional_pages = {}
153 # If false, no module index is generated.
154 html_use_modindex = False
156 # If false, no index is generated.
157 html_use_index = False
159 # If true, the index is split into individual pages for each letter.
160 #html_split_index = False
162 # If true, links to the reST sources are added to the pages.
163 #html_show_sourcelink = True
165 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
166 #html_show_sphinx = True
168 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
169 #html_show_copyright = True
171 # If true, an OpenSearch description file will be output, and all pages will
172 # contain a <link> tag referring to it. The value of this option must be the
173 # base URL from which the finished HTML is served.
174 #html_use_opensearch = ""
176 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
177 #html_file_suffix = ""
179 # Output file base name for HTML help builder.
180 htmlhelp_basename = "Ganetidoc"
183 # -- Options for LaTeX output --------------------------------------------------
185 # The paper size ("letter" or "a4").
186 #latex_paper_size = "a4"
188 # The font size ("10pt", "11pt" or "12pt").
189 #latex_font_size = "10pt"
191 # Grouping the document tree into LaTeX files. List of tuples
192 # (source start file, target name, title, author, documentclass [howto/manual]).
194 ("index", "Ganeti.tex", u"Ganeti Documentation",
195 u"Google Inc.", "manual"),
198 # The name of an image file (relative to this directory) to place at the top of
202 # For "manual" documents, if this is true, then toplevel headings are parts,
204 #latex_use_parts = False
206 # If true, show page references after internal links.
207 #latex_show_pagerefs = False
209 # If true, show URL addresses after external links.
210 #latex_show_urls = False
212 # Additional stuff for the LaTeX preamble.
215 # Documents to append as an appendix to all manuals.
216 #latex_appendices = []
218 # If false, no module index is generated.
219 latex_use_modindex = False