Normalise the elements doc

Author: Joseph-Edwards

docs/source/data-structures/elements/bipart.rst

@@ -0,0 +1,43 @@
+..
+    Copyright (c) 2021-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
+
+Bipartition
+===========
+
+.. autoclass:: Bipartition
+    :doc-only:
+    :class-doc-from: class
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~Bipartition
+    Bipartition.copy
+    Bipartition.degree
+    Bipartition.is_transverse_block
+    Bipartition.iterator
+    Bipartition.left_blocks
+    Bipartition.lookup
+    Bipartition.number_of_blocks
+    Bipartition.number_of_left_blocks
+    Bipartition.number_of_right_blocks
+    Bipartition.one
+    Bipartition.rank
+    Bipartition.right_blocks
+
+Full API
+--------
+
+.. autoclass:: Bipartition
+    :members:
+    :class-doc-from: init
+    :inherited-members:

docs/source/data-structures/elements/bipart/class.rst

@@ -0,0 +1,18 @@
+..
+    Copyright (c) 2025 Joseph Edwards
+
+    Distributed under the terms of the GPL license version 3.
+
+    The full license is in the file LICENSE, distributed with this software.
+
+Bipartitions
+============
+
+This page describes the functionality for bipartitions in
+``libsemigroups_pybind11``.
+
+.. toctree::
+    :maxdepth: 1
+
+    class
+    helpers

docs/source/data-structures/elements/bipart-helpers.rst renamed to docs/source/data-structures/elements/bipart/helpers.rst

@@ -5,22 +5,14 @@
 
     The full license is in the file LICENSE, distributed with this software.
 
-.. currentmodule:: _libsemigroups_pybind11
+.. currentmodule:: libsemigroups_pybind11
 
 Blocks
 ======
 
-This page contains an overview of the functionality in
-``libsemigroups_pybind11`` for blocks. See also :any:`Bipartition` for more
-details and context.
-
-There are a number of functions for computing things about :py:class:`Blocks`
-objects detailed below.
-
-.. toctree::
-    :maxdepth: 1
-
-    blocks-helpers
+.. autoclass:: Blocks
+    :doc-only:
+    :class-doc-from: class
 
 Contents
 --------
@@ -41,7 +33,6 @@ Full API
 --------
 
 .. autoclass:: Blocks
-    :class-doc-from: class
     :members:
+    :class-doc-from: init
     :inherited-members:
-    :special-members: __init__

docs/source/data-structures/elements/bipart/index.rst

@@ -0,0 +1,17 @@
+..
+    Copyright (c) 2025 Joseph Edwards
+
+    Distributed under the terms of the GPL license version 3.
+
+    The full license is in the file LICENSE, distributed with this software.
+
+Blocks
+======
+
+This page describes the functionality for blocks in ``libsemigroups_pybind11``.
+
+.. toctree::
+    :maxdepth: 1
+
+    class
+    helpers

docs/source/data-structures/elements/blocks.rst renamed to docs/source/data-structures/elements/blocks/class.rst

@@ -14,10 +14,8 @@ for defining elements of semigroups.
 .. toctree::
     :maxdepth: 1
 
-    bipart
-    blocks
+    bipart/index
+    blocks/index
     matrix/index
-    pperm
-    perm
-    pbr
-    transf
+    pbr/index
+    transformations/index

docs/source/data-structures/elements/blocks-helpers.rst renamed to docs/source/data-structures/elements/blocks/helpers.rst

@@ -21,6 +21,8 @@ Contents
     :signatures: short
 
     ~BMat8
+    BMat8.copy
+    BMat8.degree
     BMat8.swap
     BMat8.to_int
 

docs/source/data-structures/elements/blocks/index.rst

@@ -10,12 +10,13 @@
 Matrix
 ======
 
-It is possible to represent matrices over various semirings in
-``libsemigroups_pybind11``. The classes for matrices in
-``libsemigroups_pybind11`` are:
+This page describes the functionality for matrices over various semirings in
+``libsemigroups_pybind11``.
 
 .. toctree::
     :maxdepth: 1
 
     bmat8
+    bmat8-helpers
     matrix
+    matrix-helpers

docs/source/data-structures/elements/index.rst

@@ -26,12 +26,7 @@ While :py:class:`Matrix` is not a class the objects returned by
 as if it was a class.
 
 Some helper functions for :py:class:`Matrix` objects are documented in the
-submodule ``matrix``.
-
-.. toctree::
-    :maxdepth: 1
-
-    matrix-helpers
+submodule :any:`libsemigroups_pybind11.matrix`.
 
 .. doctest::
 
@@ -155,40 +150,6 @@ MatrixKind
 ----------
 
 .. autoclass:: MatrixKind
-    :show-inheritance:
-
-    .. autoattribute:: Boolean
-
-        For matrices over the Boolean semiring.
-
-    .. autoattribute:: Integer
-
-        For matrices over the usual ring of integers.
-
-    .. autoattribute:: MaxPlus
-
-        For matrices over the max-plus semiring.
-
-    .. autoattribute:: MinPlus
-
-        For matrices over the min-plus semiring.
-
-    .. autoattribute:: ProjMaxPlus
-
-        For projective matrices over the max-plus semiring.
-
-    .. autoattribute:: MaxPlusTrunc
-
-        For matrices over the truncated max-plus semiring.
-
-    .. autoattribute:: MinPlusTrunc
-
-        For matrices over the truncated min-plus semiring.
-
-    .. autoattribute:: NTP
-
-        For matrices over the semiring of natural numbers quotiented by `t = t +
-        p`.
 
 ..
     TODO later summary

docs/source/data-structures/elements/matrix/bmat8.rst

@@ -10,32 +10,26 @@
 PBR
 ===
 
-This page contains an overview of the functionality in
-``libsemigroups_pybind11`` for partitioned binary relations (PBRs).
-
-There are a number of functions for computing things about :py:class:`PBR`
-objects detailed below.
-
-.. toctree::
-    :maxdepth: 1
-
-    pbr-helpers
+.. autoclass:: PBR
+    :doc-only:
+    :class-doc-from: class
 
 Contents
 --------
 
 .. autosummary::
     :signatures: short
 
+    ~PBR
     PBR.copy
     PBR.degree
     PBR.number_of_points
+    PBR.product_inplace
 
 Full API
 --------
 
 .. autoclass:: PBR
-    :class-doc-from: class
     :members:
+    :class-doc-from: init
     :inherited-members:
-    :special-members: __init__

docs/source/data-structures/elements/matrix/index.rst

@@ -0,0 +1,18 @@
+..
+    Copyright (c) 2025 Joseph Edwards
+
+    Distributed under the terms of the GPL license version 3.
+
+    The full license is in the file LICENSE, distributed with this software.
+
+Partitioned binary relations (PBRs)
+===================================
+
+This page describes the functionality for partitioned binary relations (PBRs) in
+``libsemigroups_pybind11``.
+
+.. toctree::
+    :maxdepth: 1
+
+    class
+    helpers

docs/source/data-structures/elements/matrix/matrix.rst

@@ -0,0 +1,20 @@
+..
+    Copyright (c) 2025 Joseph Edwards
+
+    Distributed under the terms of the GPL license version 3.
+
+    The full license is in the file LICENSE, distributed with this software.
+
+Transformations
+===============
+
+This page describes the functionality for various partial transformations in
+``libsemigroups_pybind11``.
+
+.. toctree::
+    :maxdepth: 1
+
+    perm
+    pperm
+    transf
+    helpers