chiark / gitweb /
cryptsetup-generator: Add support for naming luks devices on kernel cmdline
[elogind.git] / src / python-systemd / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # python-systemd documentation build configuration file, created by
4 # sphinx-quickstart on Sat Feb  9 13:49:42 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.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['.']
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'python-systemd'
44
45 # The language for content autogenerated by Sphinx. Refer to documentation
46 # for a list of supported languages.
47 #language = None
48
49 # There are two options for replacing |today|: either, you set today to some
50 # non-false value, then it is used:
51 #today = ''
52 # Else, today_fmt is used as the format for a strftime call.
53 #today_fmt = '%B %d, %Y'
54
55 # List of patterns, relative to source directory, that match files and
56 # directories to ignore when looking for source files.
57 exclude_patterns = []
58
59 # The reST default role (used for this markup: `text`) to use for all documents.
60 #default_role = None
61
62 # If true, '()' will be appended to :func: etc. cross-reference text.
63 #add_function_parentheses = True
64
65 # If true, the current module name will be prepended to all description
66 # unit titles (such as .. function::).
67 #add_module_names = True
68
69 # If true, sectionauthor and moduleauthor directives will be shown in the
70 # output. They are ignored by default.
71 #show_authors = False
72
73 # The name of the Pygments (syntax highlighting) style to use.
74 pygments_style = 'sphinx'
75
76 # A list of ignored prefixes for module index sorting.
77 #modindex_common_prefix = []
78
79
80 # -- Options for HTML output ---------------------------------------------------
81
82 # The theme to use for HTML and HTML Help pages.  See the documentation for
83 # a list of builtin themes.
84 html_theme = 'default'
85
86 # Theme options are theme-specific and customize the look and feel of a theme
87 # further.  For a list of options available for each theme, see the
88 # documentation.
89 #html_theme_options = {}
90
91 # Add any paths that contain custom themes here, relative to this directory.
92 #html_theme_path = []
93
94 # The name for this set of Sphinx documents.  If None, it defaults to
95 # "<project> v<release> documentation".
96 #html_title = None
97
98 # A shorter title for the navigation bar.  Default is the same as html_title.
99 #html_short_title = None
100
101 # The name of an image file (relative to this directory) to place at the top
102 # of the sidebar.
103 #html_logo = None
104
105 # The name of an image file (within the static path) to use as favicon of the
106 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
107 # pixels large.
108 #html_favicon = None
109
110 # Add any paths that contain custom static files (such as style sheets) here,
111 # relative to this directory. They are copied after the builtin static files,
112 # so a file named "default.css" will overwrite the builtin "default.css".
113 html_static_path = ['.']
114
115 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
116 # using the given strftime format.
117 #html_last_updated_fmt = '%b %d, %Y'
118
119 # If true, SmartyPants will be used to convert quotes and dashes to
120 # typographically correct entities.
121 #html_use_smartypants = True
122
123 # Custom sidebar templates, maps document names to template names.
124 #html_sidebars = {}
125
126 # Additional templates that should be rendered to pages, maps page names to
127 # template names.
128 #html_additional_pages = {}
129
130 # If false, no module index is generated.
131 #html_domain_indices = True
132
133 # If false, no index is generated.
134 #html_use_index = True
135
136 # If true, the index is split into individual pages for each letter.
137 #html_split_index = False
138
139 # If true, links to the reST sources are added to the pages.
140 html_show_sourcelink = False
141
142 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
143 #html_show_sphinx = True
144
145 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
146 #html_show_copyright = True
147
148 # If true, an OpenSearch description file will be output, and all pages will
149 # contain a <link> tag referring to it.  The value of this option must be the
150 # base URL from which the finished HTML is served.
151 #html_use_opensearch = ''
152
153 # This is the file name suffix for HTML files (e.g. ".xhtml").
154 #html_file_suffix = None
155
156 # Output file base name for HTML help builder.
157 htmlhelp_basename = 'python-systemddoc'
158
159
160 # -- Options for LaTeX output --------------------------------------------------
161
162 latex_elements = {
163 # The paper size ('letterpaper' or 'a4paper').
164 #'papersize': 'letterpaper',
165
166 # The font size ('10pt', '11pt' or '12pt').
167 #'pointsize': '10pt',
168
169 # Additional stuff for the LaTeX preamble.
170 #'preamble': '',
171 }
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', 'python-systemd.tex', u'python-systemd Documentation',
177    None, '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 # If true, show page references after internal links.
189 #latex_show_pagerefs = False
190
191 # If true, show URL addresses after external links.
192 #latex_show_urls = False
193
194 # Documents to append as an appendix to all manuals.
195 #latex_appendices = []
196
197 # If false, no module index is generated.
198 #latex_domain_indices = True
199
200
201 # -- Options for manual page output --------------------------------------------
202
203 # One entry per manual page. List of tuples
204 # (source start file, name, description, authors, manual section).
205 man_pages = [
206     ('index', 'python-systemd', u'python-systemd Documentation',
207      [], 1)
208 ]
209
210 # If true, show URL addresses after external links.
211 #man_show_urls = False
212
213
214 # -- Options for Texinfo output ------------------------------------------------
215
216 # Grouping the document tree into Texinfo files. List of tuples
217 # (source start file, target name, title, author,
218 #  dir menu entry, description, category)
219 texinfo_documents = [
220   ('index', 'python-systemd', u'python-systemd Documentation',
221    u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks', 'python-systemd', 'One line description of project.',
222    'Miscellaneous'),
223 ]
224
225 # Documents to append as an appendix to all manuals.
226 #texinfo_appendices = []
227
228 # If false, no module index is generated.
229 #texinfo_domain_indices = True
230
231 # How to display URL addresses: 'footnote', 'no', or 'inline'.
232 #texinfo_show_urls = 'footnote'
233
234
235 # -- Options for Epub output ---------------------------------------------------
236
237 # Bibliographic Dublin Core info.
238 epub_title = u'python-systemd'
239 epub_author = u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
240 epub_publisher = u'David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
241 epub_copyright = u'2013, David Strauss, Zbigniew Jędrzejewski-Szmek, Marti Raudsepp, Steven Hiscocks'
242
243 # The language of the text. It defaults to the language option
244 # or en if the language is not set.
245 #epub_language = ''
246
247 # The scheme of the identifier. Typical schemes are ISBN or URL.
248 #epub_scheme = ''
249
250 # The unique identifier of the text. This can be a ISBN number
251 # or the project homepage.
252 #epub_identifier = ''
253
254 # A unique identification for the text.
255 #epub_uid = ''
256
257 # A tuple containing the cover image and cover page html template filenames.
258 #epub_cover = ()
259
260 # HTML files that should be inserted before the pages created by sphinx.
261 # The format is a list of tuples containing the path and title.
262 #epub_pre_files = []
263
264 # HTML files shat should be inserted after the pages created by sphinx.
265 # The format is a list of tuples containing the path and title.
266 #epub_post_files = []
267
268 # A list of files that should not be packed into the epub file.
269 #epub_exclude_files = []
270
271 # The depth of the table of contents in toc.ncx.
272 #epub_tocdepth = 3
273
274 # Allow duplicate toc entries.
275 #epub_tocdup = True
276
277
278 # Example configuration for intersphinx: refer to the Python standard library.
279 intersphinx_mapping = {'http://docs.python.org/': None}