Add minor improvements for documentation build
[cacert-codedocs.git] / source / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # Configuration file for the Sphinx documentation builder.
4 #
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/master/config
8
9 # -- Path setup --------------------------------------------------------------
10
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
14 #
15 from datetime import datetime
16 import os
17 # import sys
18 # sys.path.insert(0, os.path.abspath('.'))
19
20 from git import repo
21
22 # -- Project information -----------------------------------------------------
23
24 project = 'CAcert code documentation'
25 copyright = '2018, CAcert development team'
26 author = 'CAcert development team'
27
28 # The short X.Y version
29 version = '0.1'
30 # The full version, including alpha/beta/rc tags
31 release = "{}-git:{} built:{}".format(
32 version,
33 repo.Repo('..').git.describe('--always', '--dirty'),
34 datetime.utcnow().replace(microsecond=0))
35
36
37 # -- General configuration ---------------------------------------------------
38
39 # If your documentation needs a minimal Sphinx version, state it here.
40 #
41 # needs_sphinx = '1.0'
42
43 # Add any Sphinx extension module names here, as strings. They can be
44 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
45 # ones.
46 extensions = [
47 'sphinx.ext.intersphinx',
48 'sphinx.ext.extlinks',
49 'sphinx.ext.todo',
50 'sphinx.ext.ifconfig',
51 ]
52
53 # Add any paths that contain templates here, relative to this directory.
54 templates_path = ['_templates']
55
56 # The suffix(es) of source filenames.
57 # You can specify multiple suffix as a list of string:
58 #
59 # source_suffix = ['.rst', '.md']
60 source_suffix = '.rst'
61
62 # The master toctree document.
63 master_doc = 'index'
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 # List of patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
74 # This pattern also affects html_static_path and html_extra_path.
75 exclude_patterns = []
76
77 # The name of the Pygments (syntax highlighting) style to use.
78 pygments_style = 'sphinx'
79
80
81 # -- Options for HTML output -------------------------------------------------
82
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
85 #
86 html_theme = 'classic'
87
88 # Theme options are theme-specific and customize the look and feel of a theme
89 # further. For a list of options available for each theme, see the
90 # documentation.
91 #
92 html_theme_options = {
93 'sidebarbgcolor': '#f5f7f7',
94 'sidebartextcolor': '#334d55',
95 'sidebarlinkcolor': '#005fa9',
96 }
97
98 html_title = project + " v" + release
99
100 html_logo = os.path.join('images', 'CAcert-logo-colour.svg')
101
102 html_favicon = os.path.join('images', 'favicon.ico')
103
104 # Add any paths that contain custom static files (such as style sheets) here,
105 # relative to this directory. They are copied after the builtin static files,
106 # so a file named "default.css" will overwrite the builtin "default.css".
107 html_static_path = ['_static']
108
109 # Custom sidebar templates, must be a dictionary that maps document names
110 # to template names.
111 #
112 # The default sidebars (for documents that don't match any pattern) are
113 # defined by theme itself. Builtin themes are using these templates by
114 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
115 # 'searchbox.html']``.
116 #
117 # html_sidebars = {}
118
119
120 # -- Options for HTMLHelp output ---------------------------------------------
121
122 # Output file base name for HTML help builder.
123 htmlhelp_basename = 'CAcertcodedocumentationdoc'
124
125
126 # -- Options for LaTeX output ------------------------------------------------
127
128 latex_elements = {
129 # The paper size ('letterpaper' or 'a4paper').
130 #
131 # 'papersize': 'letterpaper',
132
133 # The font size ('10pt', '11pt' or '12pt').
134 #
135 # 'pointsize': '10pt',
136
137 # Additional stuff for the LaTeX preamble.
138 #
139 # 'preamble': '',
140
141 # Latex figure (float) alignment
142 #
143 # 'figure_align': 'htbp',
144 }
145
146 # Grouping the document tree into LaTeX files. List of tuples
147 # (source start file, target name, title,
148 # author, documentclass [howto, manual, or own class]).
149 latex_documents = [
150 (master_doc, 'CAcertcodedocumentation.tex', 'CAcert code documentation',
151 'CAcert development team', 'manual'),
152 ]
153
154
155 # -- Options for manual page output ------------------------------------------
156
157 # One entry per manual page. List of tuples
158 # (source start file, name, description, authors, manual section).
159 man_pages = [
160 (master_doc, 'cacertcodedocumentation', 'CAcert code documentation',
161 [author], 1)
162 ]
163
164
165 # -- Options for Texinfo output ----------------------------------------------
166
167 # Grouping the document tree into Texinfo files. List of tuples
168 # (source start file, target name, title, author,
169 # dir menu entry, description, category)
170 texinfo_documents = [
171 (master_doc, 'CAcertcodedocumentation', 'CAcert code documentation',
172 author, 'CAcertcodedocumentation', 'One line description of project.',
173 'Miscellaneous'),
174 ]
175
176
177 # -- Options for Epub output -------------------------------------------------
178
179 # Bibliographic Dublin Core info.
180 epub_title = project
181
182 # The unique identifier of the text. This can be a ISBN number
183 # or the project homepage.
184 #
185 # epub_identifier = ''
186
187 # A unique identification for the text.
188 #
189 # epub_uid = ''
190
191 # A list of files that should not be packed into the epub file.
192 epub_exclude_files = ['search.html']
193
194
195 # -- Extension configuration -------------------------------------------------
196
197 # -- Options for intersphinx extension ---------------------------------------
198
199 # Example configuration for intersphinx: refer to the Python standard library.
200 intersphinx_mapping = {'https://docs.python.org/': None}
201
202 # -- Options for todo extension ----------------------------------------------
203
204 # If true, `todo` and `todoList` produce output, else they produce nothing.
205 todo_include_todos = True
206
207 extlinks = {
208 'wiki': ('https://wiki.cacert.org/%s', 'Wiki '),
209 }
210
211
212 def cacert_bug(name, rawtext, text, lineno, inliner, options={}, content=[]):
213 try:
214 bugnum = int(text)
215 if bugnum <= 0:
216 raise ValueError
217 except ValueError:
218 msg = inliner.reporter.error(
219 'Bug number must be a number greater than or equal to 1; '
220 '"%s" is invalid.' % text, line=lineno)
221 prb = inliner.problematic(rawtext, rawtext, msg)
222 return [prb], [msg]
223 ref = 'https://bugs.cacert.org/view.php?id=%d' % bugnum
224 node = nodes.reference(rawtext, '#' + utils.unescape(text), refuri=ref,
225 **options)
226 return [node], []
227
228
229 def setup(app):
230 app.add_role('bug', cacert_bug)