More d o c u m e n t a t i o n improvements

libsemigroups · Dec 1, 2024 · 90321f1 · 90321f1
1 parent 8be0578
commit 90321f1
Show file tree

Hide file tree

Showing 3 changed files with 892 additions and 598 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -162,8 +162,18 @@ def no_doc_run(self):
         r"libsemigroups::IntegerProd<long long>, libsemigroups::IntegerZero"
         r"<long long>, libsemigroups::IntegerOne<long long>, long long>"
     ): r"Matrix",
+    r"libsemigroups::SimsStats": r"SimsStats",
     r"libsemigroups::Sims1": r"Sims1",
     r"SimsSettingsSims1": r"Sims1",
+    r"libsemigroups::Sims2": r"Sims2",
+    r"SimsSettingsSims2": r"Sims2",
+    r"libsemigroups::RepOrc": r"RepOrc",
+    r"SimsSettingsRepOrc": r"RepOrc",
+    (
+        r"libsemigroups::DynamicMatrix<libsemigroups::BooleanPlus, "
+        r"libsemigroups::BooleanProd, libsemigroups::BooleanZero, "
+        r"libsemigroups::BooleanOne, int>"
+    ): r"Matrix",
 }
 
 # This dictionary should be of the form class_name -> (pattern, repl), where

diff --git a/docs/source/main-algorithms/sims/sims.rst b/docs/source/main-algorithms/sims/sims.rst
@@ -34,6 +34,14 @@ Contents
 .. autosummary::
    :nosignatures:
 
+   ~Sims1
+   ~Sims2
+   ~RepOrc
+   ~MinimalRepOrc
+   ~SimsStats
+   ~SimsRefinerFaithful
+   ~SimsRefinerIdeals
+
 Full API
 --------
 
@@ -52,3 +60,17 @@ Full API
 .. autoclass:: MinimalRepOrc
    :members:
    :inherited-members:
+
+.. autoclass:: SimsStats
+   :members:
+   :inherited-members:
+
+.. autoclass:: SimsRefinerFaithful
+   :members:
+   :inherited-members:
+   :special-members: __call__
+
+.. autoclass:: SimsRefinerIdeals
+   :members:
+   :inherited-members:
+   :special-members: __call__