Write a short introduction with the purpose of the documentation
[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 import os
16 # import sys
17 # sys.path.insert(0, os.path.abspath('.'))
18
19
20 # -- Project information -----------------------------------------------------
21
22 project = 'CAcert code documentation'
23 copyright = '2018, CAcert development team'
24 author = 'CAcert development team'
25
26 # The short X.Y version
27 version = ''
28 # The full version, including alpha/beta/rc tags
29 release = ''
30
31
32 # -- General configuration ---------------------------------------------------
33
34 # If your documentation needs a minimal Sphinx version, state it here.
35 #
36 # needs_sphinx = '1.0'
37
38 # Add any Sphinx extension module names here, as strings. They can be
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40 # ones.
41 extensions = [
42 'sphinx.ext.intersphinx',
43 'sphinx.ext.todo',
44 'sphinx.ext.ifconfig',
45 ]
46
47 # Add any paths that contain templates here, relative to this directory.
48 templates_path = ['_templates']
49
50 # The suffix(es) of source filenames.
51 # You can specify multiple suffix as a list of string:
52 #
53 # source_suffix = ['.rst', '.md']
54 source_suffix = '.rst'
55
56 # The master toctree document.
57 master_doc = 'index'
58
59 # The language for content autogenerated by Sphinx. Refer to documentation
60 # for a list of supported languages.
61 #
62 # This is also used if you do content translation via gettext catalogs.
63 # Usually you set "language" from the command line for these cases.
64 language = None
65
66 # List of patterns, relative to source directory, that match files and
67 # directories to ignore when looking for source files.
68 # This pattern also affects html_static_path and html_extra_path.
69 exclude_patterns = []
70
71 # The name of the Pygments (syntax highlighting) style to use.
72 pygments_style = 'sphinx'
73
74
75 # -- Options for HTML output -------------------------------------------------
76
77 # The theme to use for HTML and HTML Help pages. See the documentation for
78 # a list of builtin themes.
79 #
80 html_theme = 'classic'
81
82 # Theme options are theme-specific and customize the look and feel of a theme
83 # further. For a list of options available for each theme, see the
84 # documentation.
85 #
86 html_theme_options = {
87 'sidebarbgcolor': '#f5f7f7',
88 'sidebartextcolor': '#334d55',
89 'sidebarlinkcolor': '#005fa9',
90 }
91
92 html_logo = os.path.join('images', 'CAcert-logo-colour.svg')
93
94 html_favicon = os.path.join('images', 'favicon.ico')
95
96 # Add any paths that contain custom static files (such as style sheets) here,
97 # relative to this directory. They are copied after the builtin static files,
98 # so a file named "default.css" will overwrite the builtin "default.css".
99 html_static_path = ['_static']
100
101 # Custom sidebar templates, must be a dictionary that maps document names
102 # to template names.
103 #
104 # The default sidebars (for documents that don't match any pattern) are
105 # defined by theme itself. Builtin themes are using these templates by
106 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
107 # 'searchbox.html']``.
108 #
109 # html_sidebars = {}
110
111
112 # -- Options for HTMLHelp output ---------------------------------------------
113
114 # Output file base name for HTML help builder.
115 htmlhelp_basename = 'CAcertcodedocumentationdoc'
116
117
118 # -- Options for LaTeX output ------------------------------------------------
119
120 latex_elements = {
121 # The paper size ('letterpaper' or 'a4paper').
122 #
123 # 'papersize': 'letterpaper',
124
125 # The font size ('10pt', '11pt' or '12pt').
126 #
127 # 'pointsize': '10pt',
128
129 # Additional stuff for the LaTeX preamble.
130 #
131 # 'preamble': '',
132
133 # Latex figure (float) alignment
134 #
135 # 'figure_align': 'htbp',
136 }
137
138 # Grouping the document tree into LaTeX files. List of tuples
139 # (source start file, target name, title,
140 # author, documentclass [howto, manual, or own class]).
141 latex_documents = [
142 (master_doc, 'CAcertcodedocumentation.tex', 'CAcert code documentation Documentation',
143 'CAcert development team', 'manual'),
144 ]
145
146
147 # -- Options for manual page output ------------------------------------------
148
149 # One entry per manual page. List of tuples
150 # (source start file, name, description, authors, manual section).
151 man_pages = [
152 (master_doc, 'cacertcodedocumentation', 'CAcert code documentation Documentation',
153 [author], 1)
154 ]
155
156
157 # -- Options for Texinfo output ----------------------------------------------
158
159 # Grouping the document tree into Texinfo files. List of tuples
160 # (source start file, target name, title, author,
161 # dir menu entry, description, category)
162 texinfo_documents = [
163 (master_doc, 'CAcertcodedocumentation', 'CAcert code documentation Documentation',
164 author, 'CAcertcodedocumentation', 'One line description of project.',
165 'Miscellaneous'),
166 ]
167
168
169 # -- Options for Epub output -------------------------------------------------
170
171 # Bibliographic Dublin Core info.
172 epub_title = project
173
174 # The unique identifier of the text. This can be a ISBN number
175 # or the project homepage.
176 #
177 # epub_identifier = ''
178
179 # A unique identification for the text.
180 #
181 # epub_uid = ''
182
183 # A list of files that should not be packed into the epub file.
184 epub_exclude_files = ['search.html']
185
186
187 # -- Extension configuration -------------------------------------------------
188
189 # -- Options for intersphinx extension ---------------------------------------
190
191 # Example configuration for intersphinx: refer to the Python standard library.
192 intersphinx_mapping = {'https://docs.python.org/': None}
193
194 # -- Options for todo extension ----------------------------------------------
195
196 # If true, `todo` and `todoList` produce output, else they produce nothing.
197 todo_include_todos = True