Replace :nosignatures: in doc

james-d-mitchell · james-d-mitchell · commit 59fce8eaa43f · 2025-04-01T16:39:21.000+01:00
This is a work around for an issue in Sphinx: sphinx-doc/sphinx#13461 introduced in Sphinx 8.2.
diff --git a/docs/source/data-structures/elements/blocks.rst b/docs/source/data-structures/elements/blocks.rst
@@ -25,7 +25,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~Blocks
    Blocks.copy
diff --git a/docs/source/data-structures/elements/matrix/bmat8-helpers.rst b/docs/source/data-structures/elements/matrix/bmat8-helpers.rst
@@ -19,7 +19,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.bmat8
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    col_space_basis
    col_space_size
diff --git a/docs/source/data-structures/elements/matrix/bmat8.rst b/docs/source/data-structures/elements/matrix/bmat8.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
 
     ~BMat8
     BMat8.swap
diff --git a/docs/source/data-structures/elements/matrix/matrix-helpers.rst b/docs/source/data-structures/elements/matrix/matrix-helpers.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    matrix.period
    matrix.row_basis
diff --git a/docs/source/data-structures/elements/pbr.rst b/docs/source/data-structures/elements/pbr.rst
@@ -24,7 +24,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    PBR.copy
    PBR.degree
diff --git a/docs/source/data-structures/elements/perm.rst b/docs/source/data-structures/elements/perm.rst
@@ -37,7 +37,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~Perm1
    Perm1.copy
diff --git a/docs/source/data-structures/elements/pperm.rst b/docs/source/data-structures/elements/pperm.rst
@@ -33,7 +33,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~PPerm1
    PPerm1.copy
diff --git a/docs/source/data-structures/elements/transf.rst b/docs/source/data-structures/elements/transf.rst
@@ -32,7 +32,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~Transf1
    Transf1.copy
diff --git a/docs/source/data-structures/misc/reporter.rst b/docs/source/data-structures/misc/reporter.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
 
     ~Reporter
     Reporter.init
diff --git a/docs/source/data-structures/misc/runner.rst b/docs/source/data-structures/misc/runner.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
 
     ~Runner
      Runner.current_state
diff --git a/docs/source/data-structures/order/index.rst b/docs/source/data-structures/order/index.rst
@@ -16,7 +16,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    Order
    lexicographical_compare
diff --git a/docs/source/data-structures/presentations/examples.rst b/docs/source/data-structures/presentations/examples.rst
@@ -25,7 +25,7 @@ functions; functions that should be used when the particular relations
 aren't important, only the semigroup or monoid they define.
 
 .. autosummary:: 
-   :nosignatures:
+   :signatures: short
 
    alternating_group
    brauer_monoid
@@ -76,7 +76,7 @@ For each semigroup or monoid, there is a corresponding default
 function that is documented in the :ref:`default-presentations` section.
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    alternating_group_Moo97
    brauer_monoid_KM07
diff --git a/docs/source/data-structures/presentations/inverse-present.rst b/docs/source/data-structures/presentations/inverse-present.rst
@@ -31,7 +31,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
    
    libsemigroups_pybind11.InversePresentation
    InversePresentationStrings.inverse
diff --git a/docs/source/data-structures/presentations/present-helpers.rst b/docs/source/data-structures/presentations/present-helpers.rst
@@ -31,7 +31,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.presentation
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    add_identity_rules
    add_inverse_rules
diff --git a/docs/source/data-structures/presentations/present.rst b/docs/source/data-structures/presentations/present.rst
@@ -31,7 +31,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
    
    PresentationStrings.add_generator
    PresentationStrings.alphabet
diff --git a/docs/source/data-structures/suffix-trees/class.rst b/docs/source/data-structures/suffix-trees/class.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
 
     ~Ukkonen.State
     Ukkonen.State.pos
diff --git a/docs/source/data-structures/suffix-trees/helpers.rst b/docs/source/data-structures/suffix-trees/helpers.rst
@@ -18,7 +18,7 @@ In ``libsemigroups_pybind11``:
 .. currentmodule:: libsemigroups_pybind11.ukkonen
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    add_word
    add_words
diff --git a/docs/source/data-structures/tries/class.rst b/docs/source/data-structures/tries/class.rst
@@ -16,7 +16,7 @@ Contents
 --------
 
 .. autosummary:: 
-   :nosignatures:
+   :signatures: short
 
    AhoCorasick.child
    AhoCorasick.height
diff --git a/docs/source/data-structures/tries/helpers.rst b/docs/source/data-structures/tries/helpers.rst
@@ -55,7 +55,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.aho_corasick
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    add_word
    dot
diff --git a/docs/source/data-structures/visualisation/dot.rst b/docs/source/data-structures/visualisation/dot.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
    
    ~Dot
    Dot.Edge
diff --git a/docs/source/data-structures/word-graph/forest.rst b/docs/source/data-structures/word-graph/forest.rst
@@ -15,7 +15,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
     
     ~Forest
     Forest.add_nodes
diff --git a/docs/source/data-structures/word-graph/gabow/index.rst b/docs/source/data-structures/word-graph/gabow/index.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    Gabow.component
    Gabow.component_of
diff --git a/docs/source/data-structures/word-graph/helpers.rst b/docs/source/data-structures/word-graph/helpers.rst
@@ -17,7 +17,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.word_graph
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    add_cycle
    adjacency_matrix
diff --git a/docs/source/data-structures/word-graph/joiner.rst b/docs/source/data-structures/word-graph/joiner.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
     
     ~Joiner
     Joiner.__call__
diff --git a/docs/source/data-structures/word-graph/meeter.rst b/docs/source/data-structures/word-graph/meeter.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
     
     ~Meeter
     Meeter.__call__
diff --git a/docs/source/data-structures/word-graph/paths/paths.rst b/docs/source/data-structures/word-graph/paths/paths.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
 	 Paths.at_end
 	 Paths.count
diff --git a/docs/source/data-structures/word-graph/word-graph.rst b/docs/source/data-structures/word-graph/word-graph.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
     
     ~WordGraph
     WordGraph.add_nodes
diff --git a/docs/source/data-structures/words/string-range.rst b/docs/source/data-structures/words/string-range.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~StringRange
    StringRange.alphabet
diff --git a/docs/source/data-structures/words/to-string.rst b/docs/source/data-structures/words/to-string.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~ToString
    ToString.alphabet
diff --git a/docs/source/data-structures/words/to-word.rst b/docs/source/data-structures/words/to-word.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~ToWord
    ToWord.alphabet
diff --git a/docs/source/data-structures/words/word-funcs.rst b/docs/source/data-structures/words/word-funcs.rst
@@ -31,7 +31,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.words
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
     human_readable_index
     human_readable_letter
diff --git a/docs/source/data-structures/words/word-range.rst b/docs/source/data-structures/words/word-range.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~WordRange
    WordRange.alphabet_size
diff --git a/docs/source/main-algorithms/action/index.rst b/docs/source/main-algorithms/action/index.rst
@@ -76,7 +76,7 @@ Contents
 --------
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
     
     ~RightActionPPerm1List
     RightActionPPerm1List.add_generator
diff --git a/docs/source/main-algorithms/congruence/cong.rst b/docs/source/main-algorithms/congruence/cong.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~CongruenceWord
    CongruenceWord.add_generating_pair
diff --git a/docs/source/main-algorithms/congruence/helpers.rst b/docs/source/main-algorithms/congruence/helpers.rst
@@ -16,7 +16,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.congruence
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    non_trivial_classes
    partition
diff --git a/docs/source/main-algorithms/froidure-pin/froidure-pin-base.rst b/docs/source/main-algorithms/froidure-pin/froidure-pin-base.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
    
    FroidurePinBase.batch_size
    FroidurePinBase.contains_one
diff --git a/docs/source/main-algorithms/froidure-pin/froidure-pin.rst b/docs/source/main-algorithms/froidure-pin/froidure-pin.rst
@@ -17,7 +17,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
    
    FroidurePinPBR.add_generator
    FroidurePinPBR.add_generators
diff --git a/docs/source/main-algorithms/froidure-pin/helpers.rst b/docs/source/main-algorithms/froidure-pin/helpers.rst
@@ -10,7 +10,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.froidure_pin
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    current_position
    current_minimal_factorisation
diff --git a/docs/source/main-algorithms/kambites/class.rst b/docs/source/main-algorithms/kambites/class.rst
@@ -17,7 +17,7 @@ Contents
 -------- 
 
 .. autosummary::
-    :nosignatures:
+    :signatures: short
 
     ~KambitesMultiStringView
     KambitesMultiStringView.contains
diff --git a/docs/source/main-algorithms/kambites/helpers.rst b/docs/source/main-algorithms/kambites/helpers.rst
@@ -16,7 +16,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.kambites
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    normal_forms
    non_trivial_classes
diff --git a/docs/source/main-algorithms/knuth-bendix/class/index.rst b/docs/source/main-algorithms/knuth-bendix/class/index.rst
@@ -23,7 +23,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~KnuthBendixStringRewriteTrie
    KnuthBendixStringRewriteTrie.active_rules
diff --git a/docs/source/main-algorithms/knuth-bendix/helpers.rst b/docs/source/main-algorithms/knuth-bendix/helpers.rst
@@ -23,7 +23,7 @@ Contents
 .. currentmodule:: libsemigroups_pybind11.knuth_bendix
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    by_overlap_length
    is_reduced
diff --git a/docs/source/main-algorithms/konieczny/DClass.rst b/docs/source/main-algorithms/konieczny/DClass.rst
@@ -15,7 +15,7 @@ Contents
 --------
 
 .. autosummary::
-   :nosignatures:
+   :signatures: short
 
    ~KoniecznyBMat8DClass
    KoniecznyBMat8DClass.contains
diff --git a/docs/source/main-algorithms/konieczny/class.rst b/docs/source/main-algorithms/konieczny/class.rst
diff --git a/docs/source/main-algorithms/low-index/classes/minimalreporc.rst b/docs/source/main-algorithms/low-index/classes/minimalreporc.rst
diff --git a/docs/source/main-algorithms/low-index/classes/reporc.rst b/docs/source/main-algorithms/low-index/classes/reporc.rst
diff --git a/docs/source/main-algorithms/low-index/classes/sims1.rst b/docs/source/main-algorithms/low-index/classes/sims1.rst
diff --git a/docs/source/main-algorithms/low-index/classes/sims2.rst b/docs/source/main-algorithms/low-index/classes/sims2.rst
diff --git a/docs/source/main-algorithms/low-index/classes/simsrefinerfaithful.rst b/docs/source/main-algorithms/low-index/classes/simsrefinerfaithful.rst
diff --git a/docs/source/main-algorithms/low-index/classes/simsrefinerideals.rst b/docs/source/main-algorithms/low-index/classes/simsrefinerideals.rst
diff --git a/docs/source/main-algorithms/low-index/classes/simsstats.rst b/docs/source/main-algorithms/low-index/classes/simsstats.rst
diff --git a/docs/source/main-algorithms/low-index/helpers.rst b/docs/source/main-algorithms/low-index/helpers.rst
diff --git a/docs/source/main-algorithms/schreier-sims/class.rst b/docs/source/main-algorithms/schreier-sims/class.rst
diff --git a/docs/source/main-algorithms/schreier-sims/helpers.rst b/docs/source/main-algorithms/schreier-sims/helpers.rst
diff --git a/docs/source/main-algorithms/todd-coxeter/helpers.rst b/docs/source/main-algorithms/todd-coxeter/helpers.rst
