# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1692122845 -7200
# Node ID 26a6c218a66a87a38b450e3d09907e7780d51efe
# Parent  0c73d95ec454e0f4b719e002cee79563128b1042
- Document the optional module configmix._speedups somewhat
- Make the Sphinx primary domain explicit: py

diff -r 0c73d95ec454 -r 26a6c218a66a docs/apidoc.rst
--- 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.
diff -r 0c73d95ec454 -r 26a6c218a66a docs/conf.py
--- a/docs/conf.py	Tue Aug 15 18:22:55 2023 +0200
+++ b/docs/conf.py	Tue Aug 15 20:07:25 2023 +0200
@@ -21,6 +21,7 @@
 from configmix.compat import u
 
 needs_sphinx = "5.1"
+primary_domain = "py"
 
 
 # -- Project information -----------------------------------------------------