conf.py 7.04 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# -*- coding: utf-8 -*-
#
# Ganeti documentation build configuration file, created by
# sphinx-quickstart on Tue Apr 14 13:23:20 2009.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

16 17
enable_manpages = bool(os.getenv("ENABLE_MANPAGES"))

18 19 20
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Iustin Pop's avatar
Iustin Pop committed
21
#sys.path.append(os.path.abspath("."))
22 23 24

# -- General configuration -----------------------------------------------------

Iustin Pop's avatar
Iustin Pop committed
25
# If your documentation needs a minimal Sphinx version, state it here.
26
needs_sphinx = "1.0"
Iustin Pop's avatar
Iustin Pop committed
27

28
# Add any Sphinx extension module names here, as strings. They can be extensions
Iustin Pop's avatar
Iustin Pop committed
29 30 31 32 33
# coming with Sphinx (named "sphinx.ext.*") or your custom ones.
extensions = [
  "sphinx.ext.todo",
  "sphinx.ext.graphviz",
  "ganeti.build.sphinx_ext",
34
  "ganeti.build.shell_example_lexer",
Iustin Pop's avatar
Iustin Pop committed
35
  ]
36 37

# Add any paths that contain templates here, relative to this directory.
Iustin Pop's avatar
Iustin Pop committed
38
templates_path = ["_templates"]
39 40

# The suffix of source filenames.
Iustin Pop's avatar
Iustin Pop committed
41
source_suffix = ".rst"
42 43

# The encoding of source files.
Iustin Pop's avatar
Iustin Pop committed
44
source_encoding = "utf-8"
45 46

# The master toctree document.
Iustin Pop's avatar
Iustin Pop committed
47
master_doc = "index"
48 49

# General information about the project.
Iustin Pop's avatar
Iustin Pop committed
50
project = u"Ganeti"
Klaus Aehlig's avatar
Klaus Aehlig committed
51
copyright = u"%s Google Inc." % ", ".join(map(str, range(2006, 2015 + 1)))
52 53 54 55 56 57 58 59 60 61 62 63 64

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# These next two will be passed via the command line, see the makefile
# The short X.Y version
#version = VERSION_MAJOR + "." + VERSION_MINOR
# The full version, including alpha/beta/rc tags.
#release = PACKAGE_VERSION

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Iustin Pop's avatar
Iustin Pop committed
65
language = "en"
66 67 68

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Iustin Pop's avatar
Iustin Pop committed
69
#today = ""
70
# Else, today_fmt is used as the format for a strftime call.
Iustin Pop's avatar
Iustin Pop committed
71
#today_fmt = "%B %d, %Y"
72 73 74 75

# List of documents that shouldn't be included in the build.
#unused_docs = []

76 77 78 79 80 81 82
if enable_manpages:
  exclude_patterns = []
else:
  exclude_patterns = [
    "man-*.rst",
    ]

83 84
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
Iustin Pop's avatar
Iustin Pop committed
85 86 87 88 89 90
exclude_trees = [
  "_build",
  "api",
  "coverage"
  "examples",
  ]
91 92 93 94

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

Iustin Pop's avatar
Iustin Pop committed
95
# If true, "()" will be appended to :func: etc. cross-reference text.
96 97 98 99 100 101 102 103 104 105 106
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
Iustin Pop's avatar
Iustin Pop committed
107
pygments_style = "sphinx"
108 109 110 111 112 113 114

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

Iustin Pop's avatar
Iustin Pop committed
115 116 117
# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = "default"
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
146 147 148
html_static_path = ["css"]

html_style = "style.css"
149

Iustin Pop's avatar
Iustin Pop committed
150
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
151
# using the given strftime format.
Iustin Pop's avatar
Iustin Pop committed
152
#html_last_updated_fmt = "%b %d, %Y"
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
html_use_modindex = False

# If false, no index is generated.
html_use_index = False

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

Iustin Pop's avatar
Iustin Pop committed
177 178 179 180 181 182
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

183 184 185
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
Iustin Pop's avatar
Iustin Pop committed
186
#html_use_opensearch = ""
187 188

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
Iustin Pop's avatar
Iustin Pop committed
189
#html_file_suffix = ""
190 191

# Output file base name for HTML help builder.
Iustin Pop's avatar
Iustin Pop committed
192
htmlhelp_basename = "Ganetidoc"
193 194 195 196


# -- Options for LaTeX output --------------------------------------------------

Iustin Pop's avatar
Iustin Pop committed
197 198
# The paper size ("letter" or "a4").
#latex_paper_size = "a4"
199

Iustin Pop's avatar
Iustin Pop committed
200 201
# The font size ("10pt", "11pt" or "12pt").
#latex_font_size = "10pt"
202 203 204 205

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
Iustin Pop's avatar
Iustin Pop committed
206 207
  ("index", "Ganeti.tex", u"Ganeti Documentation",
   u"Google Inc.", "manual"),
208 209 210 211 212 213 214 215 216 217
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

Iustin Pop's avatar
Iustin Pop committed
218 219 220 221 222 223
# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

224
# Additional stuff for the LaTeX preamble.
Iustin Pop's avatar
Iustin Pop committed
225
#latex_preamble = ""
226 227 228 229 230 231

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
latex_use_modindex = False