comparison docs/apidoc.rst @ 716:26a6c218a66a

- 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
comparison
equal deleted inserted replaced
715:0c73d95ec454 716:26a6c218a66a
105 ---------------------------- 105 ----------------------------
106 106
107 .. automodule:: configmix.yaml 107 .. automodule:: configmix.yaml
108 :members: 108 :members:
109 :ignore-module-all: 109 :ignore-module-all:
110
111
112 Module :mod:`configmix._speedups`
113 ---------------------------------
114
115 .. module:: configmix._speedups
116 :synopsis: Optional alternate implementations for some functions
117 in C using Python's C-API
118
119 This module is implemented in C using Python's C-API.
120 It contains alternate implementations for some heavily used
121 functions and/or methods. The module functions are not supposed to be
122 called directly. Their signatures may or may not match their
123 pure-Python equivalents because they may be called by appropriate
124 tiny Python wrappers.
125
126 This module is optional.
127
128 The module is only available for CPython >= 3.7 and uses its stable API.