Include AnyMap in Python docs

Cantera · Apr 18, 2023 · b676438 · b676438
1 parent 22ddb16
commit b676438
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/doc/sphinx/cython/utilities.rst b/doc/sphinx/cython/utilities.rst
@@ -6,8 +6,13 @@ Utilities
 .. contents::
    :local:
 
-YAML Output
------------
+YAML Input/Output
+-----------------
+
+AnyMap
+^^^^^^
+
+.. autoclass:: AnyMap
 
 YamlWriter
 ^^^^^^^^^^

diff --git a/doc/sphinx/yaml/general.rst b/doc/sphinx/yaml/general.rst
@@ -40,6 +40,8 @@ following structure::
     - equation: A + C <=> 2 D
       # Additional fields come after this
 
+.. _sec-yaml-units:
+
 Units
 -----
 

diff --git a/interfaces/cython/cantera/_utils.pyx b/interfaces/cython/cantera/_utils.pyx
@@ -155,6 +155,13 @@ cdef public PyObject* pyCanteraError = <PyObject*>CanteraError
 
 
 cdef class AnyMap(dict):
+    """
+    A key-value store representing objects defined in Cantera's YAML input format.
+
+    Extends the capabilities of a normal `dict` object by providing functions for
+    converting values between different unit systems. See :ref:`sec-yaml-units` for
+    details on how units are handled in YAML input files.
+    """
     def __cinit__(self, *args, **kwawrgs):
         self.unitsystem = UnitSystem()