forest: add PathsToRoots

Author: james-d-mitchell

docs/source/_ext/libsemigroups_pybind11_extensions.py

@@ -115,6 +115,8 @@ def no_doc_run(self):
     "RepOrc": [
         ("SimsSettingsRepOrc", "RepOrc"),
     ],
+    "PathsToRoots": [("forest_PathsFromToRootsCommon", "PathsToRoots")],
+    "PathsFromRoots": [("forest_PathsFromToRootsCommon", "PathsFromRoots")],
 }
 
 # This dictionary should be of the form bad_string -> good_string. These
@@ -462,8 +464,8 @@ def document_class(app, what, name, obj, options, lines):
 2. :returns:
 3. :rtype:
 4. :raises:
-5. :complexity: 
-6. .. note:: 
+5. :complexity:
+6. .. note::
 7. .. warning::
 8. .. seealso::
 9. .. doctest::

docs/source/data-structures/word-graph/forest-helpers.rst

@@ -0,0 +1,41 @@
+..
+    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.
+
+Forest helpers
+==============
+
+This page contains the documentation for various helper classes and functions
+for manipulating :any:`Forest` objects. All such classes and functions
+are in the submodule ``forest``.
+
+Contents
+--------
+
+.. currentmodule:: libsemigroups_pybind11.forest
+
+.. autosummary::
+   :signatures: short
+
+   PathsFromRoots
+   PathsToRoots
+   depth
+   dot
+   is_root
+   max_label
+   path_from_root
+   path_to_root
+
+
+Full API
+--------
+
+.. currentmodule:: libsemigroups_pybind11
+
+.. automodule:: libsemigroups_pybind11.forest
+   :members:
+   :imported-members:
+   :inherited-members:

docs/source/data-structures/word-graph/word-graph-helpers.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.
+
+WordGraph helpers
+=================
+
+This page contains the documentation for various helper functions for
+manipulating word graphs.
+
+Contents
+--------
+
+.. currentmodule:: libsemigroups_pybind11.word_graph
+
+.. autosummary::
+    :signatures: short
+
+    add_cycle
+    adjacency_matrix
+    dot
+    equal_to
+    follow_path
+    is_acyclic
+    is_compatible
+    is_complete
+    is_connected
+    is_reachable
+    is_strictly_cyclic
+    last_node_on_path
+    nodes_reachable_from
+    number_of_nodes_reachable_from
+    random_acyclic
+    spanning_tree
+    standardize
+    topological_sort
+
+Full API
+--------
+
+.. currentmodule:: libsemigroups_pybind11
+
+.. automodule:: libsemigroups_pybind11.word_graph
+    :members:
+    :imported-members: