Testing out a mermaid class diagram.

doc/api.rst

@@ -9,6 +9,31 @@ included in each section.
 
 For a more structured introduction to the library see the `Tour of bitformat <https://nbviewer.org/github/scott-griffiths/bitformat/blob/main/doc/bitformat_tour.ipynb>`_.
 
+.. mermaid::
+
+    ---
+    title: Classes in bitformat
+    ---
+    classDiagram
+        class Bits {
+        }
+        class Dtype {
+            + str name
+            + int size
+        }
+        class FieldType{
+            + str name
+        }
+        class Field{
+            + Dtype dtype
+            + Any value
+        }
+        class Format{
+            + List[FieldType] fields
+        }
+        FieldType <|-- Field
+        FieldType <|-- Format
+
 The Basics
 ----------
 The :class:`Bits` and :class:`Dtype` classes are the most fundamental ones to use and understand.

doc/conf.py

@@ -16,7 +16,7 @@
 author = "Scott Griffiths"
 release = "0.2.0"
 
-extensions = ["sphinx.ext.autodoc"]
+extensions = ["sphinx.ext.autodoc", "sphinxcontrib.mermaid"]
 autoapi_dirs = ["../bitformat/"]
 autoapi_add_toctree_entry = False
 autodoc_mock_imports = ["bitformat.bit_rust", "lark"]

doc/requirements.txt

@@ -1,3 +1,4 @@
 sphinx==8.1.3
 piccolo-theme==0.24.0
 sphinx-autoapi==3.3.2
+sphinxcontrib-mermaid==1.0.0