Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/apidoc.rst @ 716:26a6c218a66a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- Document the optional module configmix._speedups somewhat - Make the Sphinx primary domain explicit: py
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 15 Aug 2023 20:07:25 +0200
parents 465bac57b97e
children 65ff0f61af37
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 :ignore-module-all:
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
30
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
31 .. autoclass:: Configuration
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
32 :members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
33 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
34 :special-members: __getitem__, __getattr__, __contains__
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
35
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
36 .. autoclass:: CoercingMethodsMixin
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
37 :members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
38 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
39
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
40 While not instantiable directly, but only by
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
41 :meth:`Configuration.jailed`, the API use will want to know its interface:
397
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
42
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
43 .. autoclass:: _JailedConfiguration
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
44 :members:
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
45 :undoc-members:
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
46 :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
47
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
48 Some public helper functions:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
49
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
50 .. autofunction:: py_quote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
51
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
52 .. autofunction:: py_unquote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
53
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
54 .. autofunction:: py_pathstr2path
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
55
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
56
303
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
57 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
58 ---------------------------------
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
59
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
60 .. automodule:: configmix.constants
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
61 :members:
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
62
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
63
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
64 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
65 ---------------------------
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
66
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
67 .. automodule:: configmix.ini
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
68 :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
69 :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
70
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
71
126
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
72 Module :mod:`configmix.json`
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
73 ----------------------------
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
74
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
75 .. automodule:: configmix.json
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
76 :members:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
77 :ignore-module-all:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
78
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
79
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
80 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
81 --------------------------
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
82
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
83 .. automodule:: configmix.py
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
84 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
85 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
86
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
87
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
88 Module :mod:`configmix.toml`
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
89 ----------------------------
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
90
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
91 .. automodule:: configmix.toml
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
92 :members:
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
93 :ignore-module-all:
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
94
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
95
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
96 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
97 ---------------------------------
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
98
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
99 .. automodule:: configmix.variables
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
100 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
101 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
102
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
103
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
104 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
105 ----------------------------
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
106
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
107 .. automodule:: configmix.yaml
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
108 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
109 :ignore-module-all:
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
110
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
111
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
112 Module :mod:`configmix._speedups`
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
113 ---------------------------------
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
114
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
115 .. module:: configmix._speedups
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
116 :synopsis: Optional alternate implementations for some functions
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
117 in C using Python's C-API
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
118
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
119 This module is implemented in C using Python's C-API.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
120 It contains alternate implementations for some heavily used
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
121 functions and/or methods. The module functions are not supposed to be
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
122 called directly. Their signatures may or may not match their
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
123 pure-Python equivalents because they may be called by appropriate
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
124 tiny Python wrappers.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
125
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
126 This module is optional.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
127
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
128 The module is only available for CPython >= 3.7 and uses its stable API.