Mercurial > hgrepos > Python > libs > ConfigMix

annotate doc/conf.py @ 154:28164259aa83

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
FIX: Build docu with Python: remove all warnings
author Franz Glasner <hg@dom66.de>
date Sat, 14 Apr 2018 17:32:22 +0200
parents d51a18e5b0e3
children e2e8d21b4122
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
3 # Configuration file for the Sphinx documentation builder.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
4 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
5 # This file does only contain a selection of the most common options. For a
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
6 # full list see the documentation:
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
7 # http://www.sphinx-doc.org/en/stable/config
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
8
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
9 # -- Path setup --------------------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
10
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
11 # If extensions (or modules to document with autodoc) are in another directory,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12 # add these directories to sys.path here. If the directory is relative to the
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
14 #
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
15 import os
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
16 import sys
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
17 sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
18
57
a3f64253de70 Read the version and release information from the "configmix" package
Franz Glasner <hg@dom66.de>
parents: 55
diff changeset
19 import configmix
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
20 from configmix.compat import u
57
a3f64253de70 Read the version and release information from the "configmix" package
Franz Glasner <hg@dom66.de>
parents: 55
diff changeset
21
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
22
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
23 # -- Project information -----------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
24
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
25 project = 'ConfigMix'
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
26 copyright = u('2015–2018, Franz Glasner. All rights reserved')
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
27 author = 'Franz Glasner'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
28
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
29 # The short X.Y version
57
a3f64253de70 Read the version and release information from the "configmix" package
Franz Glasner <hg@dom66.de>
parents: 55
diff changeset
30 version = '.'.join(configmix.__version__.split('.')[:2])
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
31 # The full version, including alpha/beta/rc tags
57
a3f64253de70 Read the version and release information from the "configmix" package
Franz Glasner <hg@dom66.de>
parents: 55
diff changeset
32 release = configmix.__version__
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
33
77
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
34 today = '$Date$'
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
35 if len(today) == 6 \
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
36 and today[0] == '$' and today[1:-2] == 'Date' \
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
37 and today[-1] == '$':
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
38 del today
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
39 else:
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
40 today = today[7:today.find(' ', 7)]
025005f1234f Print the date of the docu more intelligently: use |today| together with keyword expansion
Franz Glasner <hg@dom66.de>
parents: 67
diff changeset
41
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
42
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
43 # -- General configuration ---------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
44
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
45 # If your documentation needs a minimal Sphinx version, state it here.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
46 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
47 # needs_sphinx = '1.0'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
48
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
49 # Add any Sphinx extension module names here, as strings. They can be
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
50 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
51 # ones.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
52 extensions = [
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
53 'sphinx.ext.autodoc',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
54 'sphinx.ext.intersphinx',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
55 'sphinx.ext.todo',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
56 'sphinx.ext.ifconfig',
55
51a8fa011659 Don't show RST file sources and don't show python sources
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
57 # 'sphinx.ext.viewcode',
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
58 'changelog',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
59 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
60
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
61 # Add any paths that contain templates here, relative to this directory.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
62 templates_path = ['_templates']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
63
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
64 # The suffix(es) of source filenames.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
65 # You can specify multiple suffix as a list of string:
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
66 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
67 # source_suffix = ['.rst', '.md']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
68 source_suffix = '.rst'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
69
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
70 # The master toctree document.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
71 master_doc = 'index'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
72
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
73 # The language for content autogenerated by Sphinx. Refer to documentation
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
74 # for a list of supported languages.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
75 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
76 # This is also used if you do content translation via gettext catalogs.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
77 # Usually you set "language" from the command line for these cases.
67
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
78 language = 'en'
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
79
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
80 # List of patterns, relative to source directory, that match files and
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
81 # directories to ignore when looking for source files.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
82 # This pattern also affects html_static_path and html_extra_path .
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
83 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
84
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
85 # The name of the Pygments (syntax highlighting) style to use.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
86 pygments_style = 'sphinx'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
87
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
88
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
89 # -- Options for HTML output -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
90
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
91 # The theme to use for HTML and HTML Help pages. See the documentation for
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
92 # a list of builtin themes.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
93 #
60
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 57
diff changeset
94 #html_theme = 'alabaster'
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 57
diff changeset
95 html_theme = 'haiku'
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
96
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
97 # Theme options are theme-specific and customize the look and feel of a theme
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
98 # further. For a list of options available for each theme, see the
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
99 # documentation.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
100 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
101 # html_theme_options = {}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
102
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
103 # Add any paths that contain custom static files (such as style sheets) here,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
104 # relative to this directory. They are copied after the builtin static files,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
105 # so a file named "default.css" will overwrite the builtin "default.css".
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
106 html_static_path = ['_static']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
107
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
108 # Custom sidebar templates, must be a dictionary that maps document names
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
109 # to template names.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
110 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
111 # The default sidebars (for documents that don't match any pattern) are
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
112 # defined by theme itself. Builtin themes are using these templates by
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
113 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
114 # 'searchbox.html']``.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
115 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
116 # html_sidebars = {}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
117
55
51a8fa011659 Don't show RST file sources and don't show python sources
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
118 html_show_sourcelink = False
51a8fa011659 Don't show RST file sources and don't show python sources
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
119
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
120
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
121 # -- Options for HTMLHelp output ---------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
122
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
123 # Output file base name for HTML help builder.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
124 htmlhelp_basename = 'ConfigMixdoc'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
125
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
126
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
127 # -- Options for LaTeX output ------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
128
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
129 latex_elements = {
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
130 # The paper size ('letterpaper' or 'a4paper').
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
131 #
67
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
132 'papersize': 'a4paper',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
133
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
134 # The font size ('10pt', '11pt' or '12pt').
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
135 #
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
136 'pointsize': '11pt',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
137
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
138 # Additional stuff for the LaTeX preamble.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
139 #
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
140 # NOTE: "inconsolata" in "fontpkg" errors within pdfTeX: seems to be
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
141 # incompatible with some header package.
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
142 #
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
143 'preamble': r'''
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
144 \usepackage{inconsolata}
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
145 ''',
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
146
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
147 'fontpkg': r'''
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
148 \usepackage{charter}
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
149 \usepackage[defaultsans]{lato}
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
150 ''',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
151
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
152 # Latex figure (float) alignment
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
153 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
154 # 'figure_align': 'htbp',
67
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
155 # Use "Version" instead of "Release" on the title
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
156 'releasename': 'Version',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
157 }
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
158
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
159 # Grouping the document tree into LaTeX files. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
160 # (source start file, target name, title,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
161 # author, documentclass [howto, manual, or own class]).
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
162 latex_documents = [
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
163 (master_doc, 'ConfigMix.tex', '"ConfigMix" Documentation',
66
e78f307f81a0 For LaTeX: include documents within the toctree only
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 65
diff changeset
164 'Franz Glasner', 'manual', True),
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
165 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
166
67
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
167 latex_show_urls = 'footnote'
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
168 #latex_show_pagerefs = True
67
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 66
diff changeset
169
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
170
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
171 # -- Options for manual page output ------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
172
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
173 # One entry per manual page. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
174 # (source start file, name, description, authors, manual section).
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
175 man_pages = [
88
5d47693916ee Change title of documentation
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 83
diff changeset
176 (master_doc, 'configmix', '"ConfigMix" Documentation',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
177 [author], 1)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
178 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
179
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
180
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
181 # -- Options for Texinfo output ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
182
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
183 # Grouping the document tree into Texinfo files. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
184 # (source start file, target name, title, author,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
185 # dir menu entry, description, category)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
186 texinfo_documents = [
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
187 (master_doc, 'ConfigMix', '"ConfigMix" Documentation',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
188 author, 'ConfigMix', 'One line description of project.',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
189 'Miscellaneous'),
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
190 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
191
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
192
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
193 # -- Extension configuration -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
194
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
195 # -- Options for intersphinx extension ---------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
196
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
197 # Example configuration for intersphinx: refer to the Python standard library.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
198 intersphinx_mapping = {'https://docs.python.org/': None}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
199
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
200 # -- Options for todo extension ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
201
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
202 # If true, `todo` and `todoList` produce output, else they produce nothing.
52
6c7f90dbce98 Adjusted the Copyright and change the RCS keywords in accordance with "kwarchive"
Franz Glasner <hg@dom66.de>
parents: 47
diff changeset
203 todo_include_todos = True
94
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
204 # Kein Link auf Pfad und Zeile
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
205 todo_link_only = True
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
206
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
207 # -- Options for autodoc -----------------------------------------------------
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
208
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
209 autodoc_member_order = 'bysource'
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
210 autoclass_content = 'both'
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
211
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
212
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
213 # -- Options for changelog ---------------------------------------------------
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
214
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 94
diff changeset
215 changelog_inner_tag_sort = ['breaking', 'feature', 'bugfix', 'test', 'doc']