Statistics
| Branch: | Tag: | Revision:

root / doc / conf.py @ 909948f1

History | View | Annotate | Download (6.9 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
# 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("."))
20

    
21
# -- General configuration -----------------------------------------------------
22

    
23
# If your documentation needs a minimal Sphinx version, state it here.
24
#needs_sphinx = "1.0"
25

    
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.
28
extensions = [
29
  "sphinx.ext.todo",
30
  "sphinx.ext.graphviz",
31
  "ganeti.build.sphinx_ext",
32
  "ganeti.build.shell_example_lexer",
33
  ]
34

    
35
# Add any paths that contain templates here, relative to this directory.
36
templates_path = ["_templates"]
37

    
38
# The suffix of source filenames.
39
source_suffix = ".rst"
40

    
41
# The encoding of source files.
42
source_encoding = "utf-8"
43

    
44
# The master toctree document.
45
master_doc = "index"
46

    
47
# General information about the project.
48
project = u"Ganeti"
49
copyright = u"%s Google Inc." % ", ".join(map(str, range(2006, 2013 + 1)))
50

    
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
53
# built documents.
54
#
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
60

    
61
# The language for content autogenerated by Sphinx. Refer to documentation
62
# for a list of supported languages.
63
language = "en"
64

    
65
# There are two options for replacing |today|: either, you set today to some
66
# non-false value, then it is used:
67
#today = ""
68
# Else, today_fmt is used as the format for a strftime call.
69
#today_fmt = "%B %d, %Y"
70

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

    
74
# List of directories, relative to source directory, that shouldn't be searched
75
# for source files.
76
exclude_trees = [
77
  "_build",
78
  "api",
79
  "coverage"
80
  "examples",
81
  ]
82

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

    
86
# If true, "()" will be appended to :func: etc. cross-reference text.
87
#add_function_parentheses = True
88

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

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

    
97
# The name of the Pygments (syntax highlighting) style to use.
98
pygments_style = "sphinx"
99

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

    
103

    
104
# -- Options for HTML output ---------------------------------------------------
105

    
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"
109

    
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
112
# documentation.
113
#html_theme_options = {}
114

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

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

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

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

    
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
131
# pixels large.
132
#html_favicon = None
133

    
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 = ["css"]
138

    
139
html_style = "style.css"
140

    
141
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
142
# using the given strftime format.
143
#html_last_updated_fmt = "%b %d, %Y"
144

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

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

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

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

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

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

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

    
168
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
169
#html_show_sphinx = True
170

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

    
174
# If true, an OpenSearch description file will be output, and all pages will
175
# contain a <link> tag referring to it.  The value of this option must be the
176
# base URL from which the finished HTML is served.
177
#html_use_opensearch = ""
178

    
179
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
180
#html_file_suffix = ""
181

    
182
# Output file base name for HTML help builder.
183
htmlhelp_basename = "Ganetidoc"
184

    
185

    
186
# -- Options for LaTeX output --------------------------------------------------
187

    
188
# The paper size ("letter" or "a4").
189
#latex_paper_size = "a4"
190

    
191
# The font size ("10pt", "11pt" or "12pt").
192
#latex_font_size = "10pt"
193

    
194
# Grouping the document tree into LaTeX files. List of tuples
195
# (source start file, target name, title, author, documentclass [howto/manual]).
196
latex_documents = [
197
  ("index", "Ganeti.tex", u"Ganeti Documentation",
198
   u"Google Inc.", "manual"),
199
]
200

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

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

    
209
# If true, show page references after internal links.
210
#latex_show_pagerefs = False
211

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

    
215
# Additional stuff for the LaTeX preamble.
216
#latex_preamble = ""
217

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

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