Mercurial > hgrepos > Python > libs > ConfigMix

comparison 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
comparison
equal deleted inserted replaced
716:26a6c218a66a 717:65ff0f61af37
1 .. -*- coding: utf-8 -*- 1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
2 2
3 Package API Documentation 3 Package API Documentation
4 ========================= 4 =========================
5 5
6 .. contents:: 6 .. contents::
28 .. automodule:: configmix.config 28 .. automodule:: configmix.config
29 :ignore-module-all: 29 :ignore-module-all:
30 30
31 .. autoclass:: Configuration 31 .. autoclass:: Configuration
32 :members: 32 :members:
33 :exclude-members: py_getvarl, py_getvarl_s, py_interpolate_variables
33 :undoc-members: 34 :undoc-members:
34 :special-members: __getitem__, __getattr__, __contains__ 35 :special-members: __getitem__, __getattr__, __contains__
36
37 .. automethod:: py_getvarl
38
39 Pure-Python implementation.
40
41 .. automethod:: py_getvarl_s
42
43 Pure-Python implementation.
44
45 .. automethod:: py_interpolate_variables
46
47 Pure-Python implementation.
35 48
36 .. autoclass:: CoercingMethodsMixin 49 .. autoclass:: CoercingMethodsMixin
37 :members: 50 :members:
38 :undoc-members: 51 :undoc-members:
39 52
45 :undoc-members: 58 :undoc-members:
46 :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__ 59 :special-members: __getitem__, __getattr__, __len__, __bool__, __iter__, __contains__
47 60
48 Some public helper functions: 61 Some public helper functions:
49 62
63 .. function:: quote
64
65 For documentation and the signature see :func:`py_quote`.
66
67 This function is an alias of :func:`py_quote` or
68 :func:`fast_quote` -- depending on the availability of the
69 :mod:`configmix._speedups` module.
70
71 .. function:: fast_quote
72
73 Implemented in C in :mod:`configmix._speedups`.
74
50 .. autofunction:: py_quote 75 .. autofunction:: py_quote
76
77 Pure-Python implementation.
78
79 .. function:: unquote
80
81 For documentation and the signature see :func:`py_unquote`.
82
83 This function is an alias of :func:`py_unquote` or
84 :func:`fast_unquote` -- depending on the availability of the
85 :mod:`configmix._speedups` module.
86
87 .. function:: fast_unquote
88
89 Implemented in C in :mod:`configmix._speedups`.
51 90
52 .. autofunction:: py_unquote 91 .. autofunction:: py_unquote
53 92
93 Pure-Python implementation.
94
95 .. function:: pathstr2path
96
97 For documentation and the signature see :func:`py_pathstr2path`.
98
99 This function is an alias of :func:`py_pathstr2path` or
100 :func:`fast_pathstr2path` -- depending on the availability of
101 the :mod:`configmix._speedups` module.
102
103 .. function:: fast_pathstr2path
104
105 Implemented in C in :mod:`configmix._speedups`.
106
54 .. autofunction:: py_pathstr2path 107 .. autofunction:: py_pathstr2path
108
109 Pure-Python implementation.
55 110
56 111
57 Module :mod:`configmix.constants` 112 Module :mod:`configmix.constants`
58 --------------------------------- 113 ---------------------------------
59 114
82 137
83 .. automodule:: configmix.py 138 .. automodule:: configmix.py
84 :members: 139 :members:
85 :ignore-module-all: 140 :ignore-module-all:
86 141
87 142
88 Module :mod:`configmix.toml` 143 Module :mod:`configmix.toml`
89 ---------------------------- 144 ----------------------------
90 145
91 .. automodule:: configmix.toml 146 .. automodule:: configmix.toml
92 :members: 147 :members:
93 :ignore-module-all: 148 :ignore-module-all:
94 149
95 150
96 Module :mod:`configmix.variables` 151 Module :mod:`configmix.variables`
97 --------------------------------- 152 ---------------------------------
98 153
112 Module :mod:`configmix._speedups` 167 Module :mod:`configmix._speedups`
113 --------------------------------- 168 ---------------------------------
114 169
115 .. module:: configmix._speedups 170 .. module:: configmix._speedups
116 :synopsis: Optional alternate implementations for some functions 171 :synopsis: Optional alternate implementations for some functions
117 in C using Python's C-API 172 in C using Python's C-API
118 173
119 This module is implemented in C using Python's C-API. 174 This module is implemented in C using Python's C-API.
120 It contains alternate implementations for some heavily used 175 It contains alternate implementations for some heavily used
121 functions and/or methods. The module functions are not supposed to be 176 functions and/or methods. The module functions are not supposed to be
122 called directly. Their signatures may or may not match their 177 called directly. Their signatures may or may not match their
123 pure-Python equivalents because they may be called by appropriate 178 pure-Python equivalents because they may be called by appropriate