Mercurial > hgrepos > Python > libs > ConfigMix

comparison docs/apidoc.rst @ 714:465bac57b97e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: Docs for configmix.config: use more manual docs. This is also to document more closely the pure-Python implementation, the C-API implementation and their aliases.
author Franz Glasner <f.glasner@feldmann-mg.com>
date Tue, 15 Aug 2023 17:14:21 +0200
parents 9fcdc42a0457
children 26a6c218a66a
comparison
equal deleted inserted replaced
713:1832c5d1bd00 714:465bac57b97e
24 24
25 Module :mod:`configmix.config` 25 Module :mod:`configmix.config`
26 ------------------------------ 26 ------------------------------
27 27
28 .. automodule:: configmix.config 28 .. automodule:: configmix.config
29 :members:
30 :ignore-module-all: 29 :ignore-module-all:
31 :private-members: _JailedConfiguration 30
31 .. autoclass:: Configuration
32 :members:
33 :undoc-members:
34 :special-members: __getitem__, __getattr__, __contains__
35
36 .. autoclass:: CoercingMethodsMixin
37 :members:
38 :undoc-members:
39
40 While not instantiable directly, but only by
41 :meth:`Configuration.jailed`, the API use will want to know its interface:
32 42
33 .. autoclass:: _JailedConfiguration 43 .. autoclass:: _JailedConfiguration
34 :members: 44 :members:
35 :undoc-members: 45 :undoc-members:
36 :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__ 46 :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__
47
48 Some public helper functions:
49
50 .. autofunction:: py_quote
51
52 .. autofunction:: py_unquote
53
54 .. autofunction:: py_pathstr2path
37 55
38 56
39 Module :mod:`configmix.constants` 57 Module :mod:`configmix.constants`
40 --------------------------------- 58 ---------------------------------
41 59