Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/apidoc.rst @ 717:65ff0f61af37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Enhance documentation for the API
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 16 Aug 2023 09:29:08 +0200
parents 26a6c218a66a
children c983152740b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
54
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:
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
33 :exclude-members: py_getvarl, py_getvarl_s, py_interpolate_variables
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
34 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
35 :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
36
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
37 .. automethod:: py_getvarl
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
38
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
39 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
40
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
41 .. automethod:: py_getvarl_s
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
42
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
43 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
44
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
45 .. automethod:: py_interpolate_variables
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
46
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
47 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
48
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
49 .. autoclass:: CoercingMethodsMixin
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
50 :members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
51 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
52
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
53 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
54 :meth:`Configuration.jailed`, the API use will want to know its interface:
397
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
55
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
56 .. autoclass:: _JailedConfiguration
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
57 :members:
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
58 :undoc-members:
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
59 :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
60
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
61 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
62
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
63 .. function:: quote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
64
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
65 For documentation and the signature see :func:`py_quote`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
66
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
67 This function is an alias of :func:`py_quote` or
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
68 :func:`fast_quote` -- depending on the availability of the
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
69 :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
70
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
71 .. function:: fast_quote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
72
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
73 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
74
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
75 .. autofunction:: py_quote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
76
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
77 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
78
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
79 .. function:: unquote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
80
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
81 For documentation and the signature see :func:`py_unquote`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
82
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
83 This function is an alias of :func:`py_unquote` or
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
84 :func:`fast_unquote` -- depending on the availability of the
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
85 :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
86
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
87 .. function:: fast_unquote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
88
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
89 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
90
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
91 .. autofunction:: py_unquote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
92
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
93 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
94
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
95 .. function:: pathstr2path
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
96
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
97 For documentation and the signature see :func:`py_pathstr2path`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
98
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
99 This function is an alias of :func:`py_pathstr2path` or
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
100 :func:`fast_pathstr2path` -- depending on the availability of
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
101 the :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
102
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
103 .. function:: fast_pathstr2path
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
104
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
105 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
106
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
107 .. autofunction:: py_pathstr2path
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
108
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
109 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
110
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
111
303
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
112 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
113 ---------------------------------
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
114
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
115 .. automodule:: configmix.constants
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
116 :members:
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
117
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
118
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
119 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
120 ---------------------------
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
121
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
122 .. automodule:: configmix.ini
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
123 :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
124 :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
125
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
126
126
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
127 Module :mod:`configmix.json`
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
128 ----------------------------
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
129
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
130 .. automodule:: configmix.json
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
131 :members:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
132 :ignore-module-all:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
133
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
134
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
135 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
136 --------------------------
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
137
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
138 .. automodule:: configmix.py
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
139 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
140 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
141
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
142
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
143 Module :mod:`configmix.toml`
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
144 ----------------------------
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
145
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
146 .. automodule:: configmix.toml
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
147 :members:
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
148 :ignore-module-all:
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
149
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
150
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
151 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
152 ---------------------------------
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
153
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
154 .. automodule:: configmix.variables
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
155 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
156 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
157
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
158
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
159 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
160 ----------------------------
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
161
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
162 .. automodule:: configmix.yaml
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
163 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
164 :ignore-module-all:
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
165
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
166
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
167 Module :mod:`configmix._speedups`
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
168 ---------------------------------
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
169
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
170 .. module:: configmix._speedups
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
171 :synopsis: Optional alternate implementations for some functions
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
172 in C using Python's C-API
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
173
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
174 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
175 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
176 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
177 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
178 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
179 tiny Python wrappers.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
180
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
181 This module is optional.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
182
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
183 The module is only available for CPython >= 3.7 and uses its stable API.