Statistics
| Branch: | Tag: | Revision:

root / doc / conf.py @ f154a7a3

History | View | Annotate | Download (6.3 kB)

1 d17e74b4 Iustin Pop
# -*- coding: utf-8 -*-
2 d17e74b4 Iustin Pop
#
3 d17e74b4 Iustin Pop
# Ganeti documentation build configuration file, created by
4 d17e74b4 Iustin Pop
# sphinx-quickstart on Tue Apr 14 13:23:20 2009.
5 d17e74b4 Iustin Pop
#
6 d17e74b4 Iustin Pop
# This file is execfile()d with the current directory set to its containing dir.
7 d17e74b4 Iustin Pop
#
8 d17e74b4 Iustin Pop
# Note that not all possible configuration values are present in this
9 d17e74b4 Iustin Pop
# autogenerated file.
10 d17e74b4 Iustin Pop
#
11 d17e74b4 Iustin Pop
# All configuration values have a default; values that are commented out
12 d17e74b4 Iustin Pop
# serve to show the default.
13 d17e74b4 Iustin Pop
14 d17e74b4 Iustin Pop
import sys, os
15 d17e74b4 Iustin Pop
16 d17e74b4 Iustin Pop
# If extensions (or modules to document with autodoc) are in another directory,
17 d17e74b4 Iustin Pop
# add these directories to sys.path here. If the directory is relative to the
18 d17e74b4 Iustin Pop
# documentation root, use os.path.abspath to make it absolute, like shown here.
19 d17e74b4 Iustin Pop
#sys.path.append(os.path.abspath('.'))
20 d17e74b4 Iustin Pop
21 d17e74b4 Iustin Pop
# -- General configuration -----------------------------------------------------
22 d17e74b4 Iustin Pop
23 d17e74b4 Iustin Pop
# Add any Sphinx extension module names here, as strings. They can be extensions
24 d17e74b4 Iustin Pop
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25 d17e74b4 Iustin Pop
extensions = ['sphinx.ext.todo']
26 d17e74b4 Iustin Pop
27 d17e74b4 Iustin Pop
# Add any paths that contain templates here, relative to this directory.
28 d17e74b4 Iustin Pop
templates_path = ['_templates']
29 d17e74b4 Iustin Pop
30 d17e74b4 Iustin Pop
# The suffix of source filenames.
31 d17e74b4 Iustin Pop
source_suffix = '.rst'
32 d17e74b4 Iustin Pop
33 d17e74b4 Iustin Pop
# The encoding of source files.
34 d17e74b4 Iustin Pop
source_encoding = 'utf-8'
35 d17e74b4 Iustin Pop
36 d17e74b4 Iustin Pop
# The master toctree document.
37 d17e74b4 Iustin Pop
master_doc = 'index'
38 d17e74b4 Iustin Pop
39 d17e74b4 Iustin Pop
# General information about the project.
40 d17e74b4 Iustin Pop
project = u'Ganeti'
41 d17e74b4 Iustin Pop
copyright = u'2006, 2007, 2008, 2009, Google Inc.'
42 d17e74b4 Iustin Pop
43 d17e74b4 Iustin Pop
# The version info for the project you're documenting, acts as replacement for
44 d17e74b4 Iustin Pop
# |version| and |release|, also used in various other places throughout the
45 d17e74b4 Iustin Pop
# built documents.
46 d17e74b4 Iustin Pop
#
47 d17e74b4 Iustin Pop
# These next two will be passed via the command line, see the makefile
48 d17e74b4 Iustin Pop
# The short X.Y version
49 d17e74b4 Iustin Pop
#version = VERSION_MAJOR + "." + VERSION_MINOR
50 d17e74b4 Iustin Pop
# The full version, including alpha/beta/rc tags.
51 d17e74b4 Iustin Pop
#release = PACKAGE_VERSION
52 d17e74b4 Iustin Pop
53 d17e74b4 Iustin Pop
# The language for content autogenerated by Sphinx. Refer to documentation
54 d17e74b4 Iustin Pop
# for a list of supported languages.
55 d17e74b4 Iustin Pop
language = 'en'
56 d17e74b4 Iustin Pop
57 d17e74b4 Iustin Pop
# There are two options for replacing |today|: either, you set today to some
58 d17e74b4 Iustin Pop
# non-false value, then it is used:
59 d17e74b4 Iustin Pop
#today = ''
60 d17e74b4 Iustin Pop
# Else, today_fmt is used as the format for a strftime call.
61 d17e74b4 Iustin Pop
#today_fmt = '%B %d, %Y'
62 d17e74b4 Iustin Pop
63 d17e74b4 Iustin Pop
# List of documents that shouldn't be included in the build.
64 d17e74b4 Iustin Pop
#unused_docs = []
65 d17e74b4 Iustin Pop
66 d17e74b4 Iustin Pop
# List of directories, relative to source directory, that shouldn't be searched
67 d17e74b4 Iustin Pop
# for source files.
68 d17e74b4 Iustin Pop
exclude_trees = ['_build', 'examples', 'api']
69 d17e74b4 Iustin Pop
70 d17e74b4 Iustin Pop
# The reST default role (used for this markup: `text`) to use for all documents.
71 d17e74b4 Iustin Pop
#default_role = None
72 d17e74b4 Iustin Pop
73 d17e74b4 Iustin Pop
# If true, '()' will be appended to :func: etc. cross-reference text.
74 d17e74b4 Iustin Pop
#add_function_parentheses = True
75 d17e74b4 Iustin Pop
76 d17e74b4 Iustin Pop
# If true, the current module name will be prepended to all description
77 d17e74b4 Iustin Pop
# unit titles (such as .. function::).
78 d17e74b4 Iustin Pop
#add_module_names = True
79 d17e74b4 Iustin Pop
80 d17e74b4 Iustin Pop
# If true, sectionauthor and moduleauthor directives will be shown in the
81 d17e74b4 Iustin Pop
# output. They are ignored by default.
82 d17e74b4 Iustin Pop
#show_authors = False
83 d17e74b4 Iustin Pop
84 d17e74b4 Iustin Pop
# The name of the Pygments (syntax highlighting) style to use.
85 d17e74b4 Iustin Pop
pygments_style = 'sphinx'
86 d17e74b4 Iustin Pop
87 d17e74b4 Iustin Pop
# A list of ignored prefixes for module index sorting.
88 d17e74b4 Iustin Pop
#modindex_common_prefix = []
89 d17e74b4 Iustin Pop
90 d17e74b4 Iustin Pop
91 d17e74b4 Iustin Pop
# -- Options for HTML output ---------------------------------------------------
92 d17e74b4 Iustin Pop
93 d17e74b4 Iustin Pop
# The theme to use for HTML and HTML Help pages.  Major themes that come with
94 d17e74b4 Iustin Pop
# Sphinx are currently 'default' and 'sphinxdoc'.
95 d17e74b4 Iustin Pop
html_theme = 'default'
96 d17e74b4 Iustin Pop
97 d17e74b4 Iustin Pop
# Theme options are theme-specific and customize the look and feel of a theme
98 d17e74b4 Iustin Pop
# further.  For a list of options available for each theme, see the
99 d17e74b4 Iustin Pop
# documentation.
100 d17e74b4 Iustin Pop
#html_theme_options = {}
101 d17e74b4 Iustin Pop
102 d17e74b4 Iustin Pop
# Add any paths that contain custom themes here, relative to this directory.
103 d17e74b4 Iustin Pop
#html_theme_path = []
104 d17e74b4 Iustin Pop
105 d17e74b4 Iustin Pop
# The name for this set of Sphinx documents.  If None, it defaults to
106 d17e74b4 Iustin Pop
# "<project> v<release> documentation".
107 d17e74b4 Iustin Pop
#html_title = None
108 d17e74b4 Iustin Pop
109 d17e74b4 Iustin Pop
# A shorter title for the navigation bar.  Default is the same as html_title.
110 d17e74b4 Iustin Pop
#html_short_title = None
111 d17e74b4 Iustin Pop
112 d17e74b4 Iustin Pop
# The name of an image file (relative to this directory) to place at the top
113 d17e74b4 Iustin Pop
# of the sidebar.
114 d17e74b4 Iustin Pop
#html_logo = None
115 d17e74b4 Iustin Pop
116 d17e74b4 Iustin Pop
# The name of an image file (within the static path) to use as favicon of the
117 d17e74b4 Iustin Pop
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
118 d17e74b4 Iustin Pop
# pixels large.
119 d17e74b4 Iustin Pop
#html_favicon = None
120 d17e74b4 Iustin Pop
121 d17e74b4 Iustin Pop
# Add any paths that contain custom static files (such as style sheets) here,
122 d17e74b4 Iustin Pop
# relative to this directory. They are copied after the builtin static files,
123 d17e74b4 Iustin Pop
# so a file named "default.css" will overwrite the builtin "default.css".
124 d17e74b4 Iustin Pop
html_static_path = []
125 d17e74b4 Iustin Pop
126 d17e74b4 Iustin Pop
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127 d17e74b4 Iustin Pop
# using the given strftime format.
128 d17e74b4 Iustin Pop
#html_last_updated_fmt = '%b %d, %Y'
129 d17e74b4 Iustin Pop
130 d17e74b4 Iustin Pop
# If true, SmartyPants will be used to convert quotes and dashes to
131 d17e74b4 Iustin Pop
# typographically correct entities.
132 d17e74b4 Iustin Pop
#html_use_smartypants = True
133 d17e74b4 Iustin Pop
134 d17e74b4 Iustin Pop
# Custom sidebar templates, maps document names to template names.
135 d17e74b4 Iustin Pop
#html_sidebars = {}
136 d17e74b4 Iustin Pop
137 d17e74b4 Iustin Pop
# Additional templates that should be rendered to pages, maps page names to
138 d17e74b4 Iustin Pop
# template names.
139 d17e74b4 Iustin Pop
#html_additional_pages = {}
140 d17e74b4 Iustin Pop
141 d17e74b4 Iustin Pop
# If false, no module index is generated.
142 d17e74b4 Iustin Pop
html_use_modindex = False
143 d17e74b4 Iustin Pop
144 d17e74b4 Iustin Pop
# If false, no index is generated.
145 d17e74b4 Iustin Pop
html_use_index = False
146 d17e74b4 Iustin Pop
147 d17e74b4 Iustin Pop
# If true, the index is split into individual pages for each letter.
148 d17e74b4 Iustin Pop
#html_split_index = False
149 d17e74b4 Iustin Pop
150 d17e74b4 Iustin Pop
# If true, links to the reST sources are added to the pages.
151 d17e74b4 Iustin Pop
#html_show_sourcelink = True
152 d17e74b4 Iustin Pop
153 d17e74b4 Iustin Pop
# If true, an OpenSearch description file will be output, and all pages will
154 d17e74b4 Iustin Pop
# contain a <link> tag referring to it.  The value of this option must be the
155 d17e74b4 Iustin Pop
# base URL from which the finished HTML is served.
156 d17e74b4 Iustin Pop
#html_use_opensearch = ''
157 d17e74b4 Iustin Pop
158 d17e74b4 Iustin Pop
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
159 d17e74b4 Iustin Pop
#html_file_suffix = ''
160 d17e74b4 Iustin Pop
161 d17e74b4 Iustin Pop
# Output file base name for HTML help builder.
162 d17e74b4 Iustin Pop
htmlhelp_basename = 'Ganetidoc'
163 d17e74b4 Iustin Pop
164 d17e74b4 Iustin Pop
165 d17e74b4 Iustin Pop
# -- Options for LaTeX output --------------------------------------------------
166 d17e74b4 Iustin Pop
167 d17e74b4 Iustin Pop
# The paper size ('letter' or 'a4').
168 d17e74b4 Iustin Pop
#latex_paper_size = 'letter'
169 d17e74b4 Iustin Pop
170 d17e74b4 Iustin Pop
# The font size ('10pt', '11pt' or '12pt').
171 d17e74b4 Iustin Pop
#latex_font_size = '10pt'
172 d17e74b4 Iustin Pop
173 d17e74b4 Iustin Pop
# Grouping the document tree into LaTeX files. List of tuples
174 d17e74b4 Iustin Pop
# (source start file, target name, title, author, documentclass [howto/manual]).
175 d17e74b4 Iustin Pop
latex_documents = [
176 d17e74b4 Iustin Pop
  ('index', 'Ganeti.tex', u'Ganeti Documentation',
177 d17e74b4 Iustin Pop
   u'Google Inc.', 'manual'),
178 d17e74b4 Iustin Pop
]
179 d17e74b4 Iustin Pop
180 d17e74b4 Iustin Pop
# The name of an image file (relative to this directory) to place at the top of
181 d17e74b4 Iustin Pop
# the title page.
182 d17e74b4 Iustin Pop
#latex_logo = None
183 d17e74b4 Iustin Pop
184 d17e74b4 Iustin Pop
# For "manual" documents, if this is true, then toplevel headings are parts,
185 d17e74b4 Iustin Pop
# not chapters.
186 d17e74b4 Iustin Pop
#latex_use_parts = False
187 d17e74b4 Iustin Pop
188 d17e74b4 Iustin Pop
# Additional stuff for the LaTeX preamble.
189 d17e74b4 Iustin Pop
#latex_preamble = ''
190 d17e74b4 Iustin Pop
191 d17e74b4 Iustin Pop
# Documents to append as an appendix to all manuals.
192 d17e74b4 Iustin Pop
#latex_appendices = []
193 d17e74b4 Iustin Pop
194 d17e74b4 Iustin Pop
# If false, no module index is generated.
195 d17e74b4 Iustin Pop
latex_use_modindex = False