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