Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/apidoc.rst @ 428:090a25f36a3d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
FIX: Allow jailed configurations to use correctly use base configurations that use a different "default" marker object. Jailed configurations assumed that their "default" marker object is identical to the "default" marker object in the unjailed base configuration. This is not always true, especially if "_JailedConfiguration.rebind()" is used. Removed the explicit "default" keyword argument and passed the complete keywords argument dictionary to the base instead. This triggers correct default handling in the base.
author Franz Glasner <f.glasner@feldmann-mg.com>
date Thu, 09 Dec 2021 13:02:17 +0100
parents 88239f28415c
children 6b94adc8929a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8 -*-
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2
102
c8766515bb89 Change the chapter header of the API documentation chapter to "Package API Documentation"
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 82
diff changeset
3 Package API Documentation
c8766515bb89 Change the chapter header of the API documentation chapter to "Package API Documentation"
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 82
diff changeset
4 =========================
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
5
60
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
6 .. contents::
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
7 :local:
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation
Franz Glasner <hg@dom66.de>
parents: 56
diff changeset
8
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
9 Package :mod:`configmix`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
10 ------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
11
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12 .. automodule:: configmix
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
13 :members:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
14 :ignore-module-all:
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
15
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
16
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
17 Module :mod:`configmix.compat`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
18 ------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
19
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
20 .. automodule:: configmix.compat
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
21 :members:
209
c8d071581a4c Doc: adjust documentation of configmix.compat slightly
Franz Glasner <fzglas.hg@dom66.de>
parents: 195
diff changeset
22 :undoc-members:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
23
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
24
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
25 Module :mod:`configmix.config`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
26 ------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
27
56
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
28 .. automodule:: configmix.config
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
29 :members:
1f11672c4615 Optimize the documentation: make references working with Sphinx using :role:`target`
Franz Glasner <hg@dom66.de>
parents: 54
diff changeset
30 :ignore-module-all:
397
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
31 :private-members: _JailedConfiguration
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
32
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
33 .. autoclass:: _JailedConfiguration
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
34 :members:
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
35 :undoc-members:
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
36
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
37
303
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
38 Module :mod:`configmix.constants`
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
39 ---------------------------------
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
40
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
41 .. automodule:: configmix.constants
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
42 :members:
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
43
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
44
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
45 Module :mod:`configmix.ini`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
46 ---------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
47
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
48 .. automodule:: configmix.ini
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
49 :members:
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
50 :ignore-module-all:
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
51
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
52
126
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
53 Module :mod:`configmix.json`
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
54 ----------------------------
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
55
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
56 .. automodule:: configmix.json
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
57 :members:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
58 :ignore-module-all:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
59
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
60
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
61 Module :mod:`configmix.py`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
62 --------------------------
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
63
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
64 .. automodule:: configmix.py
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
65 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
66 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
67
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
68
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
69 Module :mod:`configmix.toml`
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
70 ----------------------------
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
71
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
72 .. automodule:: configmix.toml
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
73 :members:
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
74 :ignore-module-all:
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
75
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
76
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
77 Module :mod:`configmix.variables`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
78 ---------------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
79
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
80 .. automodule:: configmix.variables
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
81 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
82 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
83
82
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
84
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
85 Module :mod:`configmix.yaml`
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
86 ----------------------------
218807d7d883 Remove header markup from the Python files and put them into the doc .rst files
Franz Glasner <hg@dom66.de>
parents: 60
diff changeset
87
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
88 .. automodule:: configmix.yaml
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
89 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
90 :ignore-module-all: