Statistics
| Branch: | Tag: | Revision:

root / doc / conf.py @ 18e2b6e4

History | View | Annotate | Download (6.3 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
# Add any Sphinx extension module names here, as strings. They can be extensions
24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25
extensions = ['sphinx.ext.todo']
26

    
27
# Add any paths that contain templates here, relative to this directory.
28
templates_path = ['_templates']
29

    
30
# The suffix of source filenames.
31
source_suffix = '.rst'
32

    
33
# The encoding of source files.
34
source_encoding = 'utf-8'
35

    
36
# The master toctree document.
37
master_doc = 'index'
38

    
39
# General information about the project.
40
project = u'Ganeti'
41
copyright = u'2006, 2007, 2008, 2009, 2010, Google Inc.'
42

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

    
53
# The language for content autogenerated by Sphinx. Refer to documentation
54
# for a list of supported languages.
55
language = 'en'
56

    
57
# There are two options for replacing |today|: either, you set today to some
58
# non-false value, then it is used:
59
#today = ''
60
# Else, today_fmt is used as the format for a strftime call.
61
#today_fmt = '%B %d, %Y'
62

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

    
66
# List of directories, relative to source directory, that shouldn't be searched
67
# for source files.
68
exclude_trees = ['_build', 'examples', 'api']
69

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

    
73
# If true, '()' will be appended to :func: etc. cross-reference text.
74
#add_function_parentheses = True
75

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

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

    
84
# The name of the Pygments (syntax highlighting) style to use.
85
pygments_style = 'sphinx'
86

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

    
90

    
91
# -- Options for HTML output ---------------------------------------------------
92

    
93
# The theme to use for HTML and HTML Help pages.  Major themes that come with
94
# Sphinx are currently 'default' and 'sphinxdoc'.
95
html_theme = 'default'
96

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

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

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

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

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

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

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

    
126
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127
# using the given strftime format.
128
#html_last_updated_fmt = '%b %d, %Y'
129

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

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

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

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

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

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

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

    
153
# If true, an OpenSearch description file will be output, and all pages will
154
# contain a <link> tag referring to it.  The value of this option must be the
155
# base URL from which the finished HTML is served.
156
#html_use_opensearch = ''
157

    
158
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
159
#html_file_suffix = ''
160

    
161
# Output file base name for HTML help builder.
162
htmlhelp_basename = 'Ganetidoc'
163

    
164

    
165
# -- Options for LaTeX output --------------------------------------------------
166

    
167
# The paper size ('letter' or 'a4').
168
#latex_paper_size = 'letter'
169

    
170
# The font size ('10pt', '11pt' or '12pt').
171
#latex_font_size = '10pt'
172

    
173
# Grouping the document tree into LaTeX files. List of tuples
174
# (source start file, target name, title, author, documentclass [howto/manual]).
175
latex_documents = [
176
  ('index', 'Ganeti.tex', u'Ganeti Documentation',
177
   u'Google Inc.', 'manual'),
178
]
179

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

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

    
188
# Additional stuff for the LaTeX preamble.
189
#latex_preamble = ''
190

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

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