Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/apidoc.rst @ 769:4a4d1323b282 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc what AWS partition is
author Franz Glasner <f.glasner@feldmann-mg.com>
date Mon, 19 Feb 2024 16:11:48 +0100
parents c983152740b0
children
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:
718
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
33 :exclude-members: getvar, py_getvar, fast_getvar,
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
34 getvar_s, py_getvar_s, fast_getvar_s,
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
35 getvarl, py_getvarl, fast_getvarl,
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
36 getvarl_s, py_getvarl_s, fast_getvarl_s,
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
37 interpolate_variables, py_interpolate_variables,
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
38 fast_interpolate_variables
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
39 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
40 :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
41
718
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
42 .. method:: getvar
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
43
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
44 For documentation and the signature see :meth:`py_getvar`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
45
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
46 This method is an alias of :func:`py_getvar` or
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
47 :func:`fast_getvar` -- depending on the availability of the
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
48 :mod:`configmix._speedups` module.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
49
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
50 .. automethod:: py_getvar
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
51
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
52 Pure-Python implementation.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
53
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
54 .. method:: fast_getvar
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
55
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
56 Implemented in C in :mod:`configmix._speedups`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
57
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
58 .. method:: getvar_s
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
59
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
60 For documentation and the signature see :meth:`py_getvar_s`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
61
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
62 This method is an alias of :func:`py_getvar_s` or
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
63 :func:`fast_getvar_s` -- depending on the availability of the
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
64 :mod:`configmix._speedups` module.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
65
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
66 .. automethod:: py_getvar_s
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
67
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
68 Pure-Python implementation.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
69
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
70 .. method:: fast_getvar_s
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
71
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
72 Implemented in C in :mod:`configmix._speedups`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
73
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
74 .. method:: getvarl
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
75
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
76 For documentation and the signature see :meth:`py_getvarl`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
77
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
78 This method is an alias of :func:`py_getvarl` or
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
79 :func:`fast_getvarl` -- depending on the availability of the
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
80 :mod:`configmix._speedups` module.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
81
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
82 .. automethod:: py_getvarl
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
83
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
84 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
85
718
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
86 .. method:: fast_getvarl
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
87
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
88 Implemented in C in :mod:`configmix._speedups`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
89
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
90 .. method:: getvarl_s
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
91
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
92 For documentation and the signature see :meth:`py_getvarl_s`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
93
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
94 This method is an alias of :func:`py_getvarl_s` or
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
95 :func:`fast_getvarl_s` -- depending on the availability of the
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
96 :mod:`configmix._speedups` module.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
97
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
98 .. automethod:: py_getvarl_s
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
99
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
100 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
101
718
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
102 .. method:: fast_getvarl_s
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
103
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
104 Implemented in C in :mod:`configmix._speedups`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
105
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
106 .. method:: interpolate_variables
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
107
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
108 For documentation and the signature see
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
109 :meth:`py_interpolate_variables`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
110
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
111 This method is an alias of :func:`py_interpolate_variables`
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
112 or :func:`fast_interpolate_variables` -- depending on the
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
113 availability of the :mod:`configmix._speedups` module.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
114
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
115 .. automethod:: py_interpolate_variables
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
116
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
117 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
118
718
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
119 .. method:: fast_interpolate_variables
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
120
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
121 Implemented in C in :mod:`configmix._speedups`.
c983152740b0 Docs for Configuration: all methods including alteriatives
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 717
diff changeset
122
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
123 .. autoclass:: CoercingMethodsMixin
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
124 :members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
125 :undoc-members:
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
126
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
127 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
128 :meth:`Configuration.jailed`, the API use will want to know its interface:
397
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
129
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
130 .. autoclass:: _JailedConfiguration
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
131 :members:
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
132 :undoc-members:
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
133 :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
134
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
135 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
136
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
137 .. function:: quote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
138
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
139 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
140
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
141 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
142 :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
143 :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
144
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
145 .. function:: fast_quote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
146
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
147 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
148
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
149 .. autofunction:: py_quote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
150
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
151 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
152
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
153 .. function:: unquote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
154
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
155 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
156
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
157 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
158 :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
159 :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
160
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
161 .. function:: fast_unquote
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
162
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
163 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
164
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
165 .. autofunction:: py_unquote
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
166
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
167 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
168
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
169 .. function:: pathstr2path
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
170
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
171 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
172
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
173 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
174 :func:`fast_pathstr2path` -- depending on the availability of
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
175 the :mod:`configmix._speedups` module.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
176
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
177 .. function:: fast_pathstr2path
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
178
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
179 Implemented in C in :mod:`configmix._speedups`.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
180
714
465bac57b97e Docs: Docs for configmix.config: use more manual docs.
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 467
diff changeset
181 .. autofunction:: py_pathstr2path
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
182
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
183 Pure-Python implementation.
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
184
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
185
303
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
186 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
187 ---------------------------------
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
188
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
189 .. automodule:: configmix.constants
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
190 :members:
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
191
2a2f5b86fe34 Move some important public constants into the .constants sub-module
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
192
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
193 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
194 ---------------------------
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
195
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
196 .. automodule:: configmix.ini
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
197 :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
198 :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
199
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
200
126
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
201 Module :mod:`configmix.json`
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
202 ----------------------------
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
203
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
204 .. automodule:: configmix.json
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
205 :members:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
206 :ignore-module-all:
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
207
93964bac7ef6 Fix the order of documented modules
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 122
diff changeset
208
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
209 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
210 --------------------------
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
211
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
212 .. automodule:: configmix.py
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
213 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
214 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
215
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
216
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
217 Module :mod:`configmix.toml`
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
218 ----------------------------
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
219
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
220 .. automodule:: configmix.toml
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
221 :members:
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
222 :ignore-module-all:
195
28e6c1413947 Added support for TOML style configuration files
Franz Glasner <fzglas.hg@dom66.de>
parents: 126
diff changeset
223
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
224
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
225 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
226 ---------------------------------
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
227
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
228 .. automodule:: configmix.variables
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
229 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
230 :ignore-module-all:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
231
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
232
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
233 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
234 ----------------------------
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
235
54
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
236 .. automodule:: configmix.yaml
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
237 :members:
aa8345dae995 Generate readable HTML documentation and an API documentation
Franz Glasner <hg@dom66.de>
parents:
diff changeset
238 :ignore-module-all:
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
239
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
240
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
241 Module :mod:`configmix._speedups`
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
242 ---------------------------------
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
243
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
244 .. module:: configmix._speedups
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
245 :synopsis: Optional alternate implementations for some functions
717
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
246 in C using Python's C-API
65ff0f61af37 Enhance documentation for the API
Franz Glasner <fzglas.hg@dom66.de>
parents: 716
diff changeset
247
716
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
248 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
249 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
250 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
251 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
252 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
253 tiny Python wrappers.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
254
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
255 This module is optional.
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
256
26a6c218a66a - Document the optional module configmix._speedups somewhat
Franz Glasner <fzglas.hg@dom66.de>
parents: 714
diff changeset
257 The module is only available for CPython >= 3.7 and uses its stable API.