add SR-IOV figure
[slides-virt.git] / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # System Virtualization and OS Virtual Machines documentation build configuration file, created by
4 # sphinx-quickstart on Mon Oct 28 09:39:30 2013.
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.insert(0, 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 = ['sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
32
33 # The suffix of source filenames.
34 source_suffix = '.rst'
35
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
38
39 # The master toctree document.
40 master_doc = 'index'
41
42 # General information about the project.
43 project = u'System Virtualization and OS Virtual Machines'
44 copyright = u'2013, Ivan Boule, Olivier Matz'
45
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
48 # built documents.
49 #
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'
54
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
57 #language = None
58
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
61 #today = ''
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
64
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']
68
69 # The reST default role (used for this markup: `text`) to use for all documents.
70 #default_role = None
71
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
74
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
78
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
81 #show_authors = False
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
88
89 # If true, keep warnings as "system message" paragraphs in the built documents.
90 #keep_warnings = False
91
92
93 # -- Options for HTML output ---------------------------------------------------
94
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'
98
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
101 # documentation.
102 #html_theme_options = {}
103
104 # Add any paths that contain custom themes here, relative to this directory.
105 #html_theme_path = []
106
107 # The name for this set of Sphinx documents.  If None, it defaults to
108 # "<project> v<release> documentation".
109 #html_title = None
110
111 # A shorter title for the navigation bar.  Default is the same as html_title.
112 #html_short_title = None
113
114 # The name of an image file (relative to this directory) to place at the top
115 # of the sidebar.
116 #html_logo = None
117
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
120 # pixels large.
121 #html_favicon = None
122
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']
127
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'
131
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
134 #html_use_smartypants = True
135
136 # Custom sidebar templates, maps document names to template names.
137 #html_sidebars = {}
138
139 # Additional templates that should be rendered to pages, maps page names to
140 # template names.
141 #html_additional_pages = {}
142
143 # If false, no module index is generated.
144 #html_domain_indices = True
145
146 # If false, no index is generated.
147 #html_use_index = True
148
149 # If true, the index is split into individual pages for each letter.
150 #html_split_index = False
151
152 # If true, links to the reST sources are added to the pages.
153 #html_show_sourcelink = True
154
155 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156 #html_show_sphinx = True
157
158 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159 #html_show_copyright = True
160
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 = ''
165
166 # This is the file name suffix for HTML files (e.g. ".xhtml").
167 #html_file_suffix = None
168
169 # Output file base name for HTML help builder.
170 htmlhelp_basename = 'SystemVirtualizationandOSVirtualMachinesdoc'
171
172
173 # -- Options for LaTeX output --------------------------------------------------
174
175 latex_elements = {
176 # The paper size ('letterpaper' or 'a4paper').
177 #'papersize': 'letterpaper',
178
179 # The font size ('10pt', '11pt' or '12pt').
180 #'pointsize': '10pt',
181
182 # Additional stuff for the LaTeX preamble.
183 #'preamble': '',
184 }
185
186 # Grouping the document tree into LaTeX files. List of tuples
187 # (source start file, target name, title, author, documentclass [howto/manual]).
188 latex_documents = [
189   ('index', 'SystemVirtualizationandOSVirtualMachines.tex', u'System Virtualization and OS Virtual Machines Documentation',
190    u'Ivan Boule, Olivier Matz', 'manual'),
191 ]
192
193 # The name of an image file (relative to this directory) to place at the top of
194 # the title page.
195 #latex_logo = None
196
197 # For "manual" documents, if this is true, then toplevel headings are parts,
198 # not chapters.
199 #latex_use_parts = False
200
201 # If true, show page references after internal links.
202 #latex_show_pagerefs = False
203
204 # If true, show URL addresses after external links.
205 #latex_show_urls = False
206
207 # Documents to append as an appendix to all manuals.
208 #latex_appendices = []
209
210 # If false, no module index is generated.
211 #latex_domain_indices = True
212
213
214 # -- Options for manual page output --------------------------------------------
215
216 # One entry per manual page. List of tuples
217 # (source start file, name, description, authors, manual section).
218 man_pages = [
219     ('index', 'systemvirtualizationandosvirtualmachines', u'System Virtualization and OS Virtual Machines Documentation',
220      [u'Ivan Boule, Olivier Matz'], 1)
221 ]
222
223 # If true, show URL addresses after external links.
224 #man_show_urls = False
225
226
227 # -- Options for Texinfo output ------------------------------------------------
228
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.',
235    'Miscellaneous'),
236 ]
237
238 # Documents to append as an appendix to all manuals.
239 #texinfo_appendices = []
240
241 # If false, no module index is generated.
242 #texinfo_domain_indices = True
243
244 # How to display URL addresses: 'footnote', 'no', or 'inline'.
245 #texinfo_show_urls = 'footnote'
246
247 # If true, do not generate a @detailmenu in the "Top" node's menu.
248 #texinfo_no_detailmenu = False
249
250
251 # -- Hieroglyph Slide Configuration ------------
252
253 extensions += [
254     'hieroglyph',
255 ]
256
257 slide_theme = 'slides'
258 slide_levels = 3
259 slide_numbers = True
260
261 # Place custom static assets in the _static directory and uncomment
262 # the following lines to include them
263
264 slide_theme_options = {
265     'custom_css': 'custom.css',
266 #     'custom_js': 'custom.js',
267 }
268
269 # ----------------------------------------------
270
271
272
273 # -- Options for Epub output ---------------------------------------------------
274
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'
280
281 # The language of the text. It defaults to the language option
282 # or en if the language is not set.
283 #epub_language = ''
284
285 # The scheme of the identifier. Typical schemes are ISBN or URL.
286 #epub_scheme = ''
287
288 # The unique identifier of the text. This can be a ISBN number
289 # or the project homepage.
290 #epub_identifier = ''
291
292 # A unique identification for the text.
293 #epub_uid = ''
294
295 # A tuple containing the cover image and cover page html template filenames.
296 #epub_cover = ()
297
298 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
299 #epub_guide = ()
300
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.
303 #epub_pre_files = []
304
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 = []
308
309 # A list of files that should not be packed into the epub file.
310 #epub_exclude_files = []
311
312 # The depth of the table of contents in toc.ncx.
313 #epub_tocdepth = 3
314
315 # Allow duplicate toc entries.
316 #epub_tocdup = True
317
318 # Fix unsupported image types using the PIL.
319 #epub_fix_images = False
320
321 # Scale large images.
322 #epub_max_image_width = 0
323
324 # If 'no', URL addresses will not be shown.
325 #epub_show_urls = 'inline'
326
327 # If false, no index is generated.
328 #epub_use_index = True
329
330
331 # Example configuration for intersphinx: refer to the Python standard library.
332 intersphinx_mapping = {'http://docs.python.org/': None}