Move documentation files to subdirectory
[cacert-infradocs.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # CAcert infrastructure documentation build configuration file, created by
4 # sphinx-quickstart on Wed Apr 13 19:34:10 2016.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14
15 import sys
16 import os
17
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 #sys.path.insert(0, os.path.abspath('.'))
22
23 # -- General configuration ------------------------------------------------
24
25 # If your documentation needs a minimal Sphinx version, state it here.
26 #needs_sphinx = '1.0'
27
28 # Add any Sphinx extension module names here, as strings. They can be
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30 # ones.
31 extensions = [
32 'sphinx.ext.todo',
33 ]
34
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
37
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
40 # source_suffix = ['.rst', '.md']
41 source_suffix = '.rst'
42
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = u'CAcert infrastructure'
51 copyright = u'2016, Jan Dittberner'
52 author = u'Jan Dittberner'
53
54 # The version info for the project you're documenting, acts as replacement for
55 # |version| and |release|, also used in various other places throughout the
56 # built documents.
57 #
58 # The short X.Y version.
59 version = u'0.1'
60 # The full version, including alpha/beta/rc tags.
61 release = u'0.1'
62
63 # The language for content autogenerated by Sphinx. Refer to documentation
64 # for a list of supported languages.
65 #
66 # This is also used if you do content translation via gettext catalogs.
67 # Usually you set "language" from the command line for these cases.
68 language = None
69
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
72 #today = ''
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 exclude_patterns = ['_build']
79
80 # The reST default role (used for this markup: `text`) to use for all
81 # documents.
82 #default_role = None
83
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 #add_function_parentheses = True
86
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 #add_module_names = True
90
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
93 #show_authors = False
94
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'sphinx'
97
98 # A list of ignored prefixes for module index sorting.
99 #modindex_common_prefix = []
100
101 # If true, keep warnings as "system message" paragraphs in the built documents.
102 #keep_warnings = False
103
104 # If true, `todo` and `todoList` produce output, else they produce nothing.
105 todo_include_todos = True
106
107
108 # -- Options for HTML output ----------------------------------------------
109
110 # The theme to use for HTML and HTML Help pages. See the documentation for
111 # a list of builtin themes.
112 html_theme = 'alabaster'
113
114 # Theme options are theme-specific and customize the look and feel of a theme
115 # further. For a list of options available for each theme, see the
116 # documentation.
117 #html_theme_options = {}
118
119 # Add any paths that contain custom themes here, relative to this directory.
120 #html_theme_path = []
121
122 # The name for this set of Sphinx documents. If None, it defaults to
123 # "<project> v<release> documentation".
124 #html_title = None
125
126 # A shorter title for the navigation bar. Default is the same as html_title.
127 #html_short_title = None
128
129 # The name of an image file (relative to this directory) to place at the top
130 # of the sidebar.
131 #html_logo = None
132
133 # The name of an image file (relative to this directory) to use as a favicon of
134 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135 # pixels large.
136 #html_favicon = None
137
138 # Add any paths that contain custom static files (such as style sheets) here,
139 # relative to this directory. They are copied after the builtin static files,
140 # so a file named "default.css" will overwrite the builtin "default.css".
141 html_static_path = ['_static']
142
143 # Add any extra paths that contain custom files (such as robots.txt or
144 # .htaccess) here, relative to this directory. These files are copied
145 # directly to the root of the documentation.
146 #html_extra_path = []
147
148 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
149 # using the given strftime format.
150 #html_last_updated_fmt = '%b %d, %Y'
151
152 # If true, SmartyPants will be used to convert quotes and dashes to
153 # typographically correct entities.
154 #html_use_smartypants = True
155
156 # Custom sidebar templates, maps document names to template names.
157 #html_sidebars = {}
158
159 # Additional templates that should be rendered to pages, maps page names to
160 # template names.
161 #html_additional_pages = {}
162
163 # If false, no module index is generated.
164 #html_domain_indices = True
165
166 # If false, no index is generated.
167 #html_use_index = True
168
169 # If true, the index is split into individual pages for each letter.
170 #html_split_index = False
171
172 # If true, links to the reST sources are added to the pages.
173 #html_show_sourcelink = True
174
175 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
176 #html_show_sphinx = True
177
178 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
179 #html_show_copyright = True
180
181 # If true, an OpenSearch description file will be output, and all pages will
182 # contain a <link> tag referring to it. The value of this option must be the
183 # base URL from which the finished HTML is served.
184 #html_use_opensearch = ''
185
186 # This is the file name suffix for HTML files (e.g. ".xhtml").
187 #html_file_suffix = None
188
189 # Language to be used for generating the HTML full-text search index.
190 # Sphinx supports the following languages:
191 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
192 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
193 #html_search_language = 'en'
194
195 # A dictionary with options for the search language support, empty by default.
196 # Now only 'ja' uses this config value
197 #html_search_options = {'type': 'default'}
198
199 # The name of a javascript file (relative to the configuration directory) that
200 # implements a search results scorer. If empty, the default will be used.
201 #html_search_scorer = 'scorer.js'
202
203 # Output file base name for HTML help builder.
204 htmlhelp_basename = 'CAcertinfrastructuredoc'
205
206 # -- Options for LaTeX output ---------------------------------------------
207
208 latex_elements = {
209 # The paper size ('letterpaper' or 'a4paper').
210 #'papersize': 'letterpaper',
211
212 # The font size ('10pt', '11pt' or '12pt').
213 #'pointsize': '10pt',
214
215 # Additional stuff for the LaTeX preamble.
216 #'preamble': '',
217
218 # Latex figure (float) alignment
219 #'figure_align': 'htbp',
220 }
221
222 # Grouping the document tree into LaTeX files. List of tuples
223 # (source start file, target name, title,
224 # author, documentclass [howto, manual, or own class]).
225 latex_documents = [
226 (master_doc, 'CAcertinfrastructure.tex', u'CAcert infrastructure Documentation',
227 u'Jan Dittberner', 'manual'),
228 ]
229
230 # The name of an image file (relative to this directory) to place at the top of
231 # the title page.
232 #latex_logo = None
233
234 # For "manual" documents, if this is true, then toplevel headings are parts,
235 # not chapters.
236 #latex_use_parts = False
237
238 # If true, show page references after internal links.
239 #latex_show_pagerefs = False
240
241 # If true, show URL addresses after external links.
242 #latex_show_urls = False
243
244 # Documents to append as an appendix to all manuals.
245 #latex_appendices = []
246
247 # If false, no module index is generated.
248 #latex_domain_indices = True
249
250
251 # -- Options for manual page output ---------------------------------------
252
253 # One entry per manual page. List of tuples
254 # (source start file, name, description, authors, manual section).
255 man_pages = [
256 (master_doc, 'cacertinfrastructure', u'CAcert infrastructure Documentation',
257 [author], 1)
258 ]
259
260 # If true, show URL addresses after external links.
261 #man_show_urls = False
262
263
264 # -- Options for Texinfo output -------------------------------------------
265
266 # Grouping the document tree into Texinfo files. List of tuples
267 # (source start file, target name, title, author,
268 # dir menu entry, description, category)
269 texinfo_documents = [
270 (master_doc, 'CAcertinfrastructure', u'CAcert infrastructure Documentation',
271 author, 'CAcertinfrastructure', 'One line description of project.',
272 'Miscellaneous'),
273 ]
274
275 # Documents to append as an appendix to all manuals.
276 #texinfo_appendices = []
277
278 # If false, no module index is generated.
279 #texinfo_domain_indices = True
280
281 # How to display URL addresses: 'footnote', 'no', or 'inline'.
282 #texinfo_show_urls = 'footnote'
283
284 # If true, do not generate a @detailmenu in the "Top" node's menu.
285 #texinfo_no_detailmenu = False
286
287
288 # -- Options for Epub output ----------------------------------------------
289
290 # Bibliographic Dublin Core info.
291 epub_title = project
292 epub_author = author
293 epub_publisher = author
294 epub_copyright = copyright
295
296 # The basename for the epub file. It defaults to the project name.
297 #epub_basename = project
298
299 # The HTML theme for the epub output. Since the default themes are not
300 # optimized for small screen space, using the same theme for HTML and epub
301 # output is usually not wise. This defaults to 'epub', a theme designed to save
302 # visual space.
303 #epub_theme = 'epub'
304
305 # The language of the text. It defaults to the language option
306 # or 'en' if the language is not set.
307 #epub_language = ''
308
309 # The scheme of the identifier. Typical schemes are ISBN or URL.
310 #epub_scheme = ''
311
312 # The unique identifier of the text. This can be a ISBN number
313 # or the project homepage.
314 #epub_identifier = ''
315
316 # A unique identification for the text.
317 #epub_uid = ''
318
319 # A tuple containing the cover image and cover page html template filenames.
320 #epub_cover = ()
321
322 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
323 #epub_guide = ()
324
325 # HTML files that should be inserted before the pages created by sphinx.
326 # The format is a list of tuples containing the path and title.
327 #epub_pre_files = []
328
329 # HTML files that should be inserted after the pages created by sphinx.
330 # The format is a list of tuples containing the path and title.
331 #epub_post_files = []
332
333 # A list of files that should not be packed into the epub file.
334 epub_exclude_files = ['search.html']
335
336 # The depth of the table of contents in toc.ncx.
337 #epub_tocdepth = 3
338
339 # Allow duplicate toc entries.
340 #epub_tocdup = True
341
342 # Choose between 'default' and 'includehidden'.
343 #epub_tocscope = 'default'
344
345 # Fix unsupported image types using the Pillow.
346 #epub_fix_images = False
347
348 # Scale large images.
349 #epub_max_image_width = 0
350
351 # How to display URL addresses: 'footnote', 'no', or 'inline'.
352 #epub_show_urls = 'inline'
353
354 # If false, no index is generated.
355 #epub_use_index = True