Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/source/_ext/libsemigroups_pybind11_extensions.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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::
Expand Down
41 changes: 41 additions & 0 deletions docs/source/data-structures/word-graph/forest-helpers.rst
Original file line number Diff line number Diff line change
@@ -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:
3 changes: 2 additions & 1 deletion docs/source/data-structures/word-graph/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ This page contains links to the documentation for the parts of
:maxdepth: 1

forest
forest-helpers
gabow
joiner
meeter
paths
word-graph
paths-helpers
helpers
word-graph-helpers
Comment thread
james-d-mitchell marked this conversation as resolved.
Loading
Loading