changeset 717:65ff0f61af37

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
files docs/apidoc.rst
diffstat 1 files changed, 60 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/docs/apidoc.rst	Tue Aug 15 20:07:25 2023 +0200
+++ b/docs/apidoc.rst	Wed Aug 16 09:29:08 2023 +0200
@@ -1,4 +1,4 @@
-.. -*- coding: utf-8 -*-
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
 
 Package API Documentation
 =========================
@@ -30,9 +30,22 @@
 
    .. autoclass:: Configuration
       :members:
+      :exclude-members: py_getvarl, py_getvarl_s, py_interpolate_variables
       :undoc-members:
       :special-members: __getitem__, __getattr__, __contains__
 
+      .. automethod:: py_getvarl
+
+         Pure-Python implementation.
+
+      .. automethod:: py_getvarl_s
+
+         Pure-Python implementation.
+
+      .. automethod:: py_interpolate_variables
+
+         Pure-Python implementation.
+
    .. autoclass:: CoercingMethodsMixin
       :members:
       :undoc-members:
@@ -47,12 +60,54 @@
 
    Some public helper functions:
 
+   .. function:: quote
+
+      For documentation and the signature see :func:`py_quote`.
+
+      This function is an alias of :func:`py_quote` or
+      :func:`fast_quote` -- depending on the availability of the
+      :mod:`configmix._speedups` module.
+
+   .. function:: fast_quote
+
+      Implemented in C in :mod:`configmix._speedups`.
+
    .. autofunction:: py_quote
 
+      Pure-Python implementation.
+
+   .. function:: unquote
+
+      For documentation and the signature see :func:`py_unquote`.
+
+      This function is an alias of :func:`py_unquote` or
+      :func:`fast_unquote` -- depending on the availability of the
+      :mod:`configmix._speedups` module.
+
+   .. function:: fast_unquote
+
+      Implemented in C in :mod:`configmix._speedups`.
+
    .. autofunction:: py_unquote
 
+      Pure-Python implementation.
+
+   .. function:: pathstr2path
+
+      For documentation and the signature see :func:`py_pathstr2path`.
+
+      This function is an alias of :func:`py_pathstr2path` or
+      :func:`fast_pathstr2path` -- depending on the availability of
+      the :mod:`configmix._speedups` module.
+
+   .. function:: fast_pathstr2path
+
+      Implemented in C in :mod:`configmix._speedups`.
+
    .. autofunction:: py_pathstr2path
 
+      Pure-Python implementation.
+
 
 Module :mod:`configmix.constants`
 ---------------------------------
@@ -84,13 +139,13 @@
    :members:
    :ignore-module-all:
 
-      
+
 Module :mod:`configmix.toml`
 ----------------------------
 
 .. automodule:: configmix.toml
    :members:
-   :ignore-module-all:      
+   :ignore-module-all:
 
 
 Module :mod:`configmix.variables`
@@ -114,8 +169,8 @@
 
 .. module:: configmix._speedups
    :synopsis: Optional alternate implementations for some functions
-	      in C using Python's C-API
-   	    
+              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