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