1 # -*- coding: utf-8 -*-
3 # System Virtualization and OS Virtual Machines documentation build configuration file, created by
4 # sphinx-quickstart on Mon Oct 28 09:39:30 2013.
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.insert(0, 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.
28 extensions = ['sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
33 # The suffix of source filenames.
34 source_suffix = '.rst'
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
39 # The master toctree document.
42 # General information about the project.
43 project = u'System Virtualization and OS Virtual Machines'
44 copyright = u'2013, Ivan Boule, Olivier Matz'
46 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the
50 # The short X.Y version.
51 version = '2013.10.28'
52 # The full version, including alpha/beta/rc tags.
53 release = '2013.10.28'
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
65 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build']
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
89 # If true, keep warnings as "system message" paragraphs in the built documents.
90 #keep_warnings = False
93 # -- Options for HTML output ---------------------------------------------------
95 # The theme to use for HTML and HTML Help pages. See the documentation for
96 # a list of builtin themes.
97 html_theme = 'default'
99 # Theme options are theme-specific and customize the look and feel of a theme
100 # further. For a list of options available for each theme, see the
102 #html_theme_options = {}
104 # Add any paths that contain custom themes here, relative to this directory.
105 #html_theme_path = []
107 # The name for this set of Sphinx documents. If None, it defaults to
108 # "<project> v<release> documentation".
111 # A shorter title for the navigation bar. Default is the same as html_title.
112 #html_short_title = None
114 # The name of an image file (relative to this directory) to place at the top
118 # The name of an image file (within the static path) to use as favicon of the
119 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 # Add any paths that contain custom static files (such as style sheets) here,
124 # relative to this directory. They are copied after the builtin static files,
125 # so a file named "default.css" will overwrite the builtin "default.css".
126 html_static_path = ['_static']
128 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129 # using the given strftime format.
130 #html_last_updated_fmt = '%b %d, %Y'
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
134 #html_use_smartypants = True
136 # Custom sidebar templates, maps document names to template names.
139 # Additional templates that should be rendered to pages, maps page names to
141 #html_additional_pages = {}
143 # If false, no module index is generated.
144 #html_domain_indices = True
146 # If false, no index is generated.
147 #html_use_index = True
149 # If true, the index is split into individual pages for each letter.
150 #html_split_index = False
152 # If true, links to the reST sources are added to the pages.
153 #html_show_sourcelink = True
155 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156 #html_show_sphinx = True
158 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159 #html_show_copyright = True
161 # If true, an OpenSearch description file will be output, and all pages will
162 # contain a <link> tag referring to it. The value of this option must be the
163 # base URL from which the finished HTML is served.
164 #html_use_opensearch = ''
166 # This is the file name suffix for HTML files (e.g. ".xhtml").
167 #html_file_suffix = None
169 # Output file base name for HTML help builder.
170 htmlhelp_basename = 'SystemVirtualizationandOSVirtualMachinesdoc'
173 # -- Options for LaTeX output --------------------------------------------------
176 # The paper size ('letterpaper' or 'a4paper').
177 #'papersize': 'letterpaper',
179 # The font size ('10pt', '11pt' or '12pt').
180 #'pointsize': '10pt',
182 # Additional stuff for the LaTeX preamble.
186 # Grouping the document tree into LaTeX files. List of tuples
187 # (source start file, target name, title, author, documentclass [howto/manual]).
189 ('index', 'SystemVirtualizationandOSVirtualMachines.tex', u'System Virtualization and OS Virtual Machines Documentation',
190 u'Ivan Boule, Olivier Matz', 'manual'),
193 # The name of an image file (relative to this directory) to place at the top of
197 # For "manual" documents, if this is true, then toplevel headings are parts,
199 #latex_use_parts = False
201 # If true, show page references after internal links.
202 #latex_show_pagerefs = False
204 # If true, show URL addresses after external links.
205 #latex_show_urls = False
207 # Documents to append as an appendix to all manuals.
208 #latex_appendices = []
210 # If false, no module index is generated.
211 #latex_domain_indices = True
214 # -- Options for manual page output --------------------------------------------
216 # One entry per manual page. List of tuples
217 # (source start file, name, description, authors, manual section).
219 ('index', 'systemvirtualizationandosvirtualmachines', u'System Virtualization and OS Virtual Machines Documentation',
220 [u'Ivan Boule, Olivier Matz'], 1)
223 # If true, show URL addresses after external links.
224 #man_show_urls = False
227 # -- Options for Texinfo output ------------------------------------------------
229 # Grouping the document tree into Texinfo files. List of tuples
230 # (source start file, target name, title, author,
231 # dir menu entry, description, category)
232 texinfo_documents = [
233 ('index', 'SystemVirtualizationandOSVirtualMachines', u'System Virtualization and OS Virtual Machines Documentation',
234 u'Ivan Boule, Olivier Matz', 'SystemVirtualizationandOSVirtualMachines', 'One line description of project.',
238 # Documents to append as an appendix to all manuals.
239 #texinfo_appendices = []
241 # If false, no module index is generated.
242 #texinfo_domain_indices = True
244 # How to display URL addresses: 'footnote', 'no', or 'inline'.
245 #texinfo_show_urls = 'footnote'
247 # If true, do not generate a @detailmenu in the "Top" node's menu.
248 #texinfo_no_detailmenu = False
251 # -- Hieroglyph Slide Configuration ------------
257 slide_theme = 'slides'
261 # Place custom static assets in the _static directory and uncomment
262 # the following lines to include them
264 slide_theme_options = {
265 'custom_css': 'custom.css',
266 # 'custom_js': 'custom.js',
269 # ----------------------------------------------
273 # -- Options for Epub output ---------------------------------------------------
275 # Bibliographic Dublin Core info.
276 epub_title = u'System Virtualization and OS Virtual Machines'
277 epub_author = u'Ivan Boule, Olivier Matz'
278 epub_publisher = u'Ivan Boule, Olivier Matz'
279 epub_copyright = u'2013, Ivan Boule, Olivier Matz'
281 # The language of the text. It defaults to the language option
282 # or en if the language is not set.
285 # The scheme of the identifier. Typical schemes are ISBN or URL.
288 # The unique identifier of the text. This can be a ISBN number
289 # or the project homepage.
290 #epub_identifier = ''
292 # A unique identification for the text.
295 # A tuple containing the cover image and cover page html template filenames.
298 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
301 # HTML files that should be inserted before the pages created by sphinx.
302 # The format is a list of tuples containing the path and title.
305 # HTML files shat should be inserted after the pages created by sphinx.
306 # The format is a list of tuples containing the path and title.
307 #epub_post_files = []
309 # A list of files that should not be packed into the epub file.
310 #epub_exclude_files = []
312 # The depth of the table of contents in toc.ncx.
315 # Allow duplicate toc entries.
318 # Fix unsupported image types using the PIL.
319 #epub_fix_images = False
321 # Scale large images.
322 #epub_max_image_width = 0
324 # If 'no', URL addresses will not be shown.
325 #epub_show_urls = 'inline'
327 # If false, no index is generated.
328 #epub_use_index = True
331 # Example configuration for intersphinx: refer to the Python standard library.
332 intersphinx_mapping = {'http://docs.python.org/': None}