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