diff 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
line wrap: on
line diff
--- a/docs/apidoc.rst	Tue Aug 15 18:22:55 2023 +0200
+++ b/docs/apidoc.rst	Tue Aug 15 20:07:25 2023 +0200
@@ -107,3 +107,22 @@
 .. automodule:: configmix.yaml
    :members:
    :ignore-module-all:
+
+
+Module :mod:`configmix._speedups`
+---------------------------------
+
+.. module:: configmix._speedups
+   :synopsis: Optional alternate implementations for some functions
+	      in C using Python's C-API
+   	    
+    This module is implemented in C using Python's C-API.
+    It contains alternate implementations for some heavily used
+    functions and/or methods. The module functions are not supposed to be
+    called directly. Their signatures may or may not match their
+    pure-Python equivalents because they may be called by appropriate
+    tiny Python wrappers.
+
+    This module is optional.
+
+    The module is only available for CPython >= 3.7 and uses its stable API.