doc: remove "::" from the doc

Author: james-d-mitchell

docs/source/main-algorithms/todd-coxeter/class/common.rst

@@ -22,8 +22,12 @@ implemented in all of the classes :any:`Congruence`, :any:`Kambites`,
 
 .. automethod:: ToddCoxeter.generating_pairs
 
+.. automethod:: ToddCoxeter.kind
+
 .. automethod:: ToddCoxeter.number_of_classes
 
+.. automethod:: ToddCoxeter.number_of_generating_pairs
+
 .. automethod:: ToddCoxeter.presentation
 
 .. automethod:: ToddCoxeter.reduce

src/bipart.cpp

@@ -419,6 +419,8 @@ of blocks in this partition.
           return Blocks(*(x.left_blocks_no_checks()));
         },
         R"pbdoc(
+:sig=(self: Bipartition) -> Blocks:
+
 Returns a copy of the left blocks of a bipartition.
 
 The *left blocks* of a bipartition is the partition of
@@ -437,6 +439,8 @@ function returns a :any:`Blocks` object representing this partition.
           return Blocks(*(x.right_blocks_no_checks()));
         },
         R"pbdoc(
+:sig=(self: Bipartition) -> Blocks:
+
 Returns a copy of the right blocks of a bipartition.
 
 The *right blocks* of a bipartition is the partition of

src/cong-common.cpp

@@ -1165,7 +1165,7 @@ the congruence represented by an instance of :any:`{name}`.
         "kind",
         [](detail::CongruenceCommon const& self) { return self.kind(); },
         R"pbdoc(
-:sig=(self: detail::CongruenceCommon) -> congruence_kind:
+:sig=(self: Congruence | Kambites | KnuthBendix | ToddCoxeter) -> congruence_kind:
 
 The kind of the congruence (1- or 2-sided).
 
@@ -1181,10 +1181,11 @@ This function returns the kind of the congruence represented by ``self``. See
    congruence_kind
 )pbdoc");
 
+    // The following does not appear in the doc, this is intentional.
     thing.def("internal_generating_pairs",
               &detail::CongruenceCommon::internal_generating_pairs,
               R"pbdoc(
-:sig=(self: detail::CongruenceCommon) -> list[list[int]]:
+:sig=(self: Congruence | Kambites | KnuthBendix | ToddCoxeter) -> list[list[int]]:
 
 Returns the generating pairs of the congruence.
 
@@ -1206,7 +1207,7 @@ the derived class.
     thing.def("number_of_generating_pairs",
               &detail::CongruenceCommon::number_of_generating_pairs,
               R"pbdoc(
-:sig=(self: detail::CongruenceCommon) -> int:
+:sig=(self: Congruence | Kambites | KnuthBendix | ToddCoxeter) -> int:
 
 Returns the number of generating pairs.
 

src/knuth-bendix.cpp

@@ -332,15 +332,21 @@ redundant in this way, then ``None`` is returned.
 )pbdoc");
 
       // Documented above
-      m.def("knuth_bendix_redundant_rule",
-            [](Presentation<std::string> const& p, std::chrono::milliseconds t)
-                -> std::optional<std::pair<std::string, std::string>> {
-              auto it = knuth_bendix::redundant_rule(p, t);
-              if (it != p.rules.cend()) {
-                return std::make_pair(*it, *(it + 1));
-              }
-              return {};
-            });
+      m.def(
+          "knuth_bendix_redundant_rule",
+          [](Presentation<std::string> const& p, std::chrono::milliseconds t)
+              -> std::optional<std::pair<std::string, std::string>> {
+            auto it = knuth_bendix::redundant_rule(p, t);
+            if (it != p.rules.cend()) {
+              return std::make_pair(*it, *(it + 1));
+            }
+            return {};
+          },
+          // Signature required to avoid generating any doc
+          R"pbdoc(
+:sig=(p: Presentation, t: datetime.timedelta) -> tuple[list[int], list[int]] | tuple[str, str] | None:
+:only-document-once:
+)pbdoc");
     }  // bind_knuth_bendix
 
     template <typename Word, typename Rewriter>

src/todd-coxeter-impl.cpp

@@ -119,8 +119,9 @@ The values in this enum can be used as the argument for
 should be performed.)pbdoc")
         .value(
             "hlt",
+            // JDM couldn't get the links to work in the following doc string.
             ToddCoxeterImpl_::options::lookahead_style::hlt,
-            R"pbdoc( The lookahead will be done in HLT style by following the paths labelled by every relation from every node in the range specified by lookahead_extent::full or lookahead_extent::partial.)pbdoc")
+            R"pbdoc(The lookahead will be done in HLT style by following the paths labelled by every relation from every node in the range specified by ``options.lookahead_extent.full`` or ``options.lookahead_extent.partial``.)pbdoc")
         .value(
             "felsch",
             ToddCoxeterImpl_::options::lookahead_style::felsch,

src/word-graph.cpp

@@ -963,7 +963,8 @@ every node is the source of an edge with every possible label.
         py::arg("first_node"),
         py::arg("last_node"),
         R"pbdoc(
-Check if every node in a range has exactly WordGraph::out_degree out-edges.
+Check if every node in a range has exactly :any:`WordGraph.out_degree`
+out-edges.
 
 This function returns ``True`` if every node in the range defined by
 *first_node* and *last_node* is complete, meaning that every such node is