Add v3 support for runner.*pp

libsemigroups · Apr 22, 2024 · 437c446 · 437c446
1 parent 42fd19c
commit 437c446
Show file tree

Hide file tree

Showing 8 changed files with 561 additions and 927 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -63,11 +63,11 @@
 
 autoclass_content = "both"
 
-# This dictionary should be of the form "bad type" -> "good type", and
-# replacements will be performed globally. Hyperlinks will be added in the
-# signature if "good type" is a valid (potentially user defined) python type
+# This dictionary should be of the form cpp type -> python type, and
+# replacements will be performed globally
 type_replacements = {
     r"libsemigroups::Presentation<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > >": r"Presentation",
+    r"libsemigroups::BMat8": r"BMat8",
 }
 
 # This dictionary should be of the form class_name -> (pattern, repl), where

diff --git a/docs/source/knuth-bendix/knuth-bendix.rst b/docs/source/knuth-bendix/knuth-bendix.rst
@@ -48,16 +48,11 @@ Contents
    KnuthBendixRewriteTrie.confluent_known
    KnuthBendixRewriteTrie.contains
    KnuthBendixRewriteTrie.current_state
-   KnuthBendixRewriteTrie.dead
-   KnuthBendixRewriteTrie.delta
    KnuthBendixRewriteTrie.equal_to
-   KnuthBendixRewriteTrie.finished
    KnuthBendixRewriteTrie.generating_pairs
    KnuthBendixRewriteTrie.gilman_graph
    KnuthBendixRewriteTrie.gilman_graph_node_labels
-   KnuthBendixRewriteTrie.kill
    KnuthBendixRewriteTrie.kind
-   KnuthBendixRewriteTrie.last_report
    KnuthBendixRewriteTrie.max_overlap
    KnuthBendixRewriteTrie.max_rules
    KnuthBendixRewriteTrie.normal_form
@@ -67,26 +62,18 @@ Contents
    KnuthBendixRewriteTrie.number_of_inactive_rules
    KnuthBendixRewriteTrie.overlap_policy
    KnuthBendixRewriteTrie.presentation
-   KnuthBendixRewriteTrie.report_every
-   KnuthBendixRewriteTrie.report_prefix
-   KnuthBendixRewriteTrie.report_why_we_stopped
-   KnuthBendixRewriteTrie.reset_last_report
-   KnuthBendixRewriteTrie.reset_start_time
    KnuthBendixRewriteTrie.rewrite
-   KnuthBendixRewriteTrie.run
-   KnuthBendixRewriteTrie.run_for
-   KnuthBendixRewriteTrie.run_until
-   KnuthBendixRewriteTrie.running
-   KnuthBendixRewriteTrie.running_for
-   KnuthBendixRewriteTrie.running_until
-   KnuthBendixRewriteTrie.start_time
-   KnuthBendixRewriteTrie.started
-   KnuthBendixRewriteTrie.stopped
-   KnuthBendixRewriteTrie.stopped_by_predicate
-   KnuthBendixRewriteTrie.timed_out
    KnuthBendixRewriteTrie.total_rules
 
 Full API
 --------
+
 .. autoclass:: KnuthBendixRewriteTrie
    :members:
+
+Methods inherited from Runner
+-----------------------------
+
+.. autoclass:: Runner
+   :members:
+   :noindex:
diff --git a/docs/source/misc.rst b/docs/source/misc.rst
@@ -13,6 +13,8 @@ In this section we describe some miscellaneous functionality in
 .. toctree::
    :maxdepth: 1
 
-   overlap
    report
-   ukkonen/index
+   runner
+   reporter
+
+.. ukkonen/index