Add v3 support for runner.*pp

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:

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

docs/source/reporter.rst

@@ -0,0 +1,37 @@
+.. Copyright (c) 2024, J. D. Mitchell
+
+   Distributed under the terms of the GPL license version 3.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+.. currentmodule:: _libsemigroups_pybind11
+
+Reporter
+========
+
+.. autoclass:: Reporter
+   :class-doc-from: class
+   :noindex:
+
+Contents
+--------
+
+.. autosummary::
+    :nosignatures:
+
+    ~Reporter
+    Reporter.init
+    Reporter.last_report
+    Reporter.report
+    Reporter.report_every
+    Reporter.report_prefix
+    Reporter.reset_last_report
+    Reporter.reset_start_time
+    Reporter.start_time
+
+Full API
+--------
+
+.. autoclass:: Reporter
+   :members:
+   :class-doc-from: init

docs/source/runner.rst

@@ -0,0 +1,48 @@
+.. Copyright (c) 2024, J. D. Mitchell
+
+   Distributed under the terms of the GPL license version 3.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+.. currentmodule:: _libsemigroups_pybind11
+
+Runner
+======
+
+TODO
+
+Contents
+--------
+
+.. autosummary::
+    :nosignatures:
+
+    ~Runner
+     Runner.current_state
+     Runner.dead
+     Runner.finished
+     Runner.kill
+     Runner.run
+     Runner.run_for
+     Runner.running
+     Runner.running_for
+     Runner.running_until
+     Runner.started
+     Runner.state
+     Runner.stopped
+     Runner.stopped_by_predicate
+     Runner.timed_out
+
+Full API
+--------
+
+.. autoclass:: Runner
+   :members:
+   :class-doc-from: class
+
+Methods inherited from Reporter
+-------------------------------
+
+.. autoclass:: Reporter
+   :members:
+   :noindex: