Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/conf.py @ 781:236a1d00b8a6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Some documentation tweaks: sync with other projects
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 16 May 2026 14:59:46 +0200
parents 48deafc1fd2f
children 8151ac02f71d
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 #
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
15 import datetime
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
16 import os
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
17 import sys
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
18
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents: 52
diff changeset
19 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
20
57
a3f64253de70 Read the version and release information from the "configmix" package
Franz Glasner <hg@dom66.de>
parents: 55
diff changeset
21 import configmix
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
22 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
23
715
0c73d95ec454 Need Sphinx >= 5.1 now for building the documentation
Franz Glasner <fzglas.hg@dom66.de>
parents: 709
diff changeset
24 needs_sphinx = "5.1"
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 715
diff changeset
25 primary_domain = "py"
715
0c73d95ec454 Need Sphinx >= 5.1 now for building the documentation
Franz Glasner <fzglas.hg@dom66.de>
parents: 709
diff changeset
26
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
27
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
28 # -- Project information -----------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
29
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
30 project = 'ConfigMix'
673
77d4a3e7c9e2 Extent all important copyright years to 2023
Franz Glasner <fzglas.hg@dom66.de>
parents: 593
diff changeset
31 copyright = u('2015–2023, Franz Glasner. All rights reserved')
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
32 author = 'Franz Glasner'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
33
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
34 current_date = datetime.date.today().isoformat()
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
35
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
36 # 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
37 release = configmix.__version__
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
38 # The short X.Y version
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
39 version = '.'.join(release.split('.')[:2])
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
40
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
41 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
42 # Optimistically assume that all keywords are expanded properly everywhere:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
43 # do not define special VCSxxx keyword below.
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
44 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
45 define_rest_keywords = False
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
46
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
47 release_date = today = configmix.__date__
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
48 if (not release_date
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
49 or (release_date.startswith("|") and release_date.endswith("|"))):
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
50 # Above assumption is not true: "hg kwarchive" nay not have been called
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
51 release_date = today = "dev-%s" % (current_date,)
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
52 define_rest_keywords = True
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
53 release_rev = configmix.__revision__
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
54 if (not release_rev
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
55 or (release_rev.startswith("|") and release_rev.endswith("|"))):
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
56 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
57 # Above assumption is not true: "hg kwarchive" may not have been called.
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
58 # Try to determine from VCS.
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
59 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
60 import subprocess
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
61 try:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
62 release_rev = subprocess.check_output(
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
63 ["hg", "id", "-i"], stderr=subprocess.STDOUT)
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
64 except Exception:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
65 release_rev = "<UNKNOWN>"
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
66 else:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
67 if sys.version_info[0] >= 3:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
68 release_rev = release_rev.decode("ascii")
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
69 release_rev = "dev-%s" % (release_rev.strip(),)
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
70 define_rest_keywords = True
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
71 else:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
72 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
73 # Assume that all keywords are expanded properly everywhere:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
74 # do not define special VCSxxx keyword below.
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
75 #
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
76 define_rest_keywords = False
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
77
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
78 # -- General configuration ---------------------------------------------------
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 # 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
81 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
82 # needs_sphinx = '1.0'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
83
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
84 # 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
85 # 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
86 # ones.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
87 extensions = [
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
88 'sphinx.ext.autodoc',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
89 'sphinx.ext.intersphinx',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
90 'sphinx.ext.todo',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
91 '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
92 # 'sphinx.ext.viewcode',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
93 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
94
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
95 # 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
96 templates_path = ['_templates']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
97
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
98 # The suffix(es) of source filenames.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
99 # 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
100 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
101 # source_suffix = ['.rst', '.md']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
102 source_suffix = '.rst'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
103
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
104 # The master toctree document.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
105 master_doc = 'index'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
106
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
107 # 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
108 # for a list of supported languages.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
109 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
110 # 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
111 # 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
112 language = 'en'
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
113
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
114 # 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
115 # 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
116 # 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
117 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
118
732
88bfa76463a6 FIX: Make all configurations on conf10.* semantically identical.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 716
diff changeset
119 # `default' is similar to python3
88bfa76463a6 FIX: Make all configurations on conf10.* semantically identical.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 716
diff changeset
120 highlight_language = "default"
88bfa76463a6 FIX: Make all configurations on conf10.* semantically identical.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 716
diff changeset
121
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
122 # 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
123 pygments_style = 'sphinx'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
124
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
125 rst_prolog = """
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
126 .. |release_date| replace:: %s
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
127 .. |release_rev| replace:: %s
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
128 """ % (release_date, release_rev)
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
129 if define_rest_keywords:
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
130 rst_prolog += """\
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
131 .. |VCSJustDate| replace:: %s
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
132 .. |VCSRevision| replace:: %s
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
133 .. |VCSHGRevision| replace:: %s
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
134 """ % (release_date, release_rev, release_rev)
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
135
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
136
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
137 # -- Options for HTML output -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
138
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
139 # 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
140 # a list of builtin themes.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
141 #
60
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 57
diff changeset
142 #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
143 html_theme = 'haiku'
159
f7114e4f3938 Adjust the HTML title for the "haiku" theme
Franz Glasner <fzglas.hg@dom66.de>
parents: 156
diff changeset
144 # for the Haiku title
f7114e4f3938 Adjust the HTML title for the "haiku" theme
Franz Glasner <fzglas.hg@dom66.de>
parents: 156
diff changeset
145 html_short_title = u("%s %s") % (project, release)
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
146 html_last_updated_fmt = "%s (rev %s)" % (current_date, release_rev)
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
147
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
148 # 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
149 # 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
150 # documentation.
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 # html_theme_options = {}
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 # 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
155 # 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
156 # 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
157 html_static_path = ['_static']
709
115de6fe420e Add a custom CSS file to use text-align "left" instead of the Haiku standard "justify"
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 673
diff changeset
158 html_css_files = ["custom-haiku.css"]
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
159
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
160 # 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
161 # to template names.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
162 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
163 # 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
164 # 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
165 # 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
166 # 'searchbox.html']``.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
167 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
168 # html_sidebars = {}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
169
770
1f076d7c721d Docs: do not copy sources
Franz Glasner <fzglas.hg@dom66.de>
parents: 732
diff changeset
170 html_copy_source = False
55
51a8fa011659 Don't show RST file sources and don't show python sources
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
171 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
172
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
173
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
174 # -- Options for HTMLHelp output ---------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
175
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
176 # 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
177 htmlhelp_basename = 'ConfigMixdoc'
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 # -- Options for LaTeX output ------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
181
771
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
182 latex_engine = 'lualatex'
772
4c44b64e32cd FIX: "xindy" is not available on FreeBSD yet
Franz Glasner <fzglas.hg@dom66.de>
parents: 771
diff changeset
183 latex_use_xindy = False # xindy not found on FreeBSD
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
184 latex_elements = {
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
185 # The paper size ('letterpaper' or 'a4paper').
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
186 #
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
187 'papersize': 'a4paper',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
188
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
189 # 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
190 #
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
191 'pointsize': '11pt',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
192
771
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
193 'babel': r'\usepackage{babel}',
776
48deafc1fd2f Use the new implementations of my-doc-fonts.sty and my-doc-style.sty.
Franz Glasner <fzglas.hg@dom66.de>
parents: 773
diff changeset
194 'preamble': r'\usepackage[stdtitle=false]{my-doc-style}',
48deafc1fd2f Use the new implementations of my-doc-fonts.sty and my-doc-style.sty.
Franz Glasner <fzglas.hg@dom66.de>
parents: 773
diff changeset
195 'maketitle': r'\builddate{%s}\vcsrevision{%s}\sphinxmaketitle' \
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
196 % (current_date, release_rev),
776
48deafc1fd2f Use the new implementations of my-doc-fonts.sty and my-doc-style.sty.
Franz Glasner <fzglas.hg@dom66.de>
parents: 773
diff changeset
197 'fontpkg': r'\usepackage[fonts=charter]{my-doc-fonts}',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
198
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
199 # Latex figure (float) alignment
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
200 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
201 # '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
202 # 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
203 'releasename': 'Version',
771
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
204
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
205 'fncychap': r'\usepackage[Sonny]{fncychap}',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
206 }
771
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
207 latex_additional_files = [
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
208 "_latex/my-doc-fonts.sty",
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
209 "_latex/my-doc-style.sty",
771
741ebfe77e55 Build the PDF documentation with lualatex now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 770
diff changeset
210 ]
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
211
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
212 # 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
213 # (source start file, target name, title,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
214 # 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
215 latex_documents = [
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
216 (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
217 'Franz Glasner', 'manual', True),
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
218 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
219
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
220 latex_show_urls = 'footnote'
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
221 #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
222
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
223
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
224 # -- Options for manual page output ------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
225
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
226 # 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
227 # (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
228 man_pages = [
88
5d47693916ee Change title of documentation
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 83
diff changeset
229 (master_doc, 'configmix', '"ConfigMix" Documentation',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
230 [author], 1)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
231 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
232
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
233
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
234 # -- Options for Texinfo output ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
235
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
236 # 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
237 # (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
238 # dir menu entry, description, category)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
239 texinfo_documents = [
154
28164259aa83 FIX: Build docu with Python: remove all warnings
Franz Glasner <hg@dom66.de>
parents: 111
diff changeset
240 (master_doc, 'ConfigMix', '"ConfigMix" Documentation',
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
241 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
242 'Miscellaneous'),
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
243 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
244
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
245
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
246 # -- Extension configuration -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
247
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
248 # -- Options for intersphinx extension ---------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
249
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
250 # Example configuration for intersphinx: refer to the Python standard library.
773
0c3507865bca FIX: Make the "intersphinx_mapping" compatible to Sphinx 8.
Franz Glasner <fzglas.hg@dom66.de>
parents: 772
diff changeset
251 intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
47
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
252
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
253 # -- Options for todo extension ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
254
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is
Franz Glasner <hg@dom66.de>
parents:
diff changeset
255 # 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
256 todo_include_todos = True
94
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
257 # Kein Link auf Pfad und Zeile
2b79ddc0f92b Begin a basic introduction chapter
Franz Glasner <hg@dom66.de>
parents: 93
diff changeset
258 todo_link_only = True
83
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
259
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
260 # -- Options for autodoc -----------------------------------------------------
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
261
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
262 autodoc_member_order = 'bysource'
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX.
Franz Glasner <hg@dom66.de>
parents: 78
diff changeset
263 autoclass_content = 'both'
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
264
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents: 88
diff changeset
265
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
266 def setup(app):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
267 #
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
268 # Custom release_date variable with a custom substitution |release_date|
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
269 # and |release_rev|'.
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
270 #
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
271 app.add_config_value('release_date', '', 'env')
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
272 app.add_config_value('release_rev', '', 'env')
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
273
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
274 import sphinx.transforms
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
275
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
276 class IAMCustomSubstitutions(sphinx.transforms.SphinxTransform):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
277
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
278 default_priority = sphinx.transforms.DefaultSubstitutions.default_priority
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
279 def apply(self):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
280 from docutils import nodes
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
281 for ref in self.document.traverse(nodes.substitution_reference):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
282 refname = ref['refname']
781
236a1d00b8a6 Some documentation tweaks: sync with other projects
Franz Glasner <fzglas.hg@dom66.de>
parents: 776
diff changeset
283 if refname in ('release_date' 'release_rev'):
163
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
284 stext = self.config[refname]
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
285 ref.replace_self(nodes.Text(stext, stext))
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
286
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 159
diff changeset
287 app.add_transform(IAMCustomSubstitutions)