More docs (#19)

* more docs and restore the tests on documentation

Author: mmatera

pymathics/graph/base.py

@@ -1054,6 +1054,8 @@ class AdjacencyList(_NetworkXBuiltin):
      = {2, 11, 100, x}
     """
 
+    summary_text = "list the adjacent vertices"
+
     def _retrieve(self, graph, what, neighbors, expression, evaluation):
         from mathics.builtin import pattern_objects
 
@@ -1519,6 +1521,10 @@ def eval_s_t(self, graph, s, t, expression, evaluation, options):
 
 class FindVertexCut(_NetworkXBuiltin):
     """
+    <url>
+    :WMA:
+    https://reference.wolfram.com/language/ref/FindVertexCut.html</url>
+
     <dl>
     <dt>'FindVertexCut[$g$]'
         <dd>finds a set of vertices of minimum cardinality that, if removed, renders $g$ disconnected.
@@ -1574,6 +1580,9 @@ def eval_st(self, graph, s, t, expression, evaluation, options):
 
 class GraphAtom(AtomBuiltin):
     """
+    <url>:Graph:https://en.wikipedia.org/wiki/graph</url> (
+    <url>:WMA:
+    https://reference.wolfram.com/language/ref/Graph.html</url>)
     <dl>
       <dt>'Graph[{$e1, $e2, ...}]'
       <dd>returns a graph with edges $e_j$.
@@ -1610,6 +1619,7 @@ class GraphAtom(AtomBuiltin):
     # requires = ("networkx",)
     name = "Graph"
     options = DEFAULT_GRAPH_OPTIONS
+    summary_text = "build a graph"
 
     def eval(self, graph, evaluation, options):
         "Pymathics`Graph[graph_List, OptionsPattern[%(name)s]]"
@@ -1867,7 +1877,19 @@ def eval_alpha_beta(self, graph, alpha, expression, evaluation, options):
 
 
 class Property(Builtin):
-    pass
+    """
+    <url>
+    :WMA:
+    https://reference.wolfram.com/language/ref/Property.html</url>
+
+    <dl>
+      <dt>'Property'[$item$, {$name$, $val$}]
+      <dd>associate a property called $name$ with value $val$ to $item$.
+    </dl>
+
+    """
+
+    summary_text = "assign a property"
 
 
 class PropertyValue(Builtin):
@@ -2041,6 +2063,9 @@ def eval(self, graph, what, expression, evaluation, options):
 
 class VertexIndex(_NetworkXBuiltin):
     """
+    <url>
+    :WMA:
+    https://reference.wolfram.com/language/ref/VertexIndex.html</url>
     <dl>
       <dt>'VertexIndex'['g', 'v']
       <dd> gives the integer index of the vertex 'v' in the\
@@ -2066,6 +2091,9 @@ def eval(self, graph, v, expression, evaluation, options):
 
 class VertexList(_PatternList):
     """
+    <url>
+    :WMA:
+    https://reference.wolfram.com/language/ref/VertexList.html</url>
     <dl>
       <dt>'VertexList[$edgelist$]'
       <dd>list the nodes from a list of directed edges.

pymathics/graph/operations.py

@@ -18,6 +18,11 @@
 
 class FindSpanningTree(_NetworkXBuiltin):
     """
+    <url>:Spanning Tree:https://en.wikipedia.org/wiki/Spanning_tree</url>
+    (<url>:WMA:
+    https://reference.wolfram.com/language/ref/FindSpanningTree.html
+    </url>)
+
     <dl>
       <dt>'FindSpanningTree'[$g$]
       <dd>finds a spanning tree of the graph $g$.
@@ -28,6 +33,7 @@ class FindSpanningTree(_NetworkXBuiltin):
     """
 
     options = DEFAULT_GRAPH_OPTIONS
+    summary_text = "find a spanning tree"
 
     def eval(self, graph, expression, evaluation: Evaluation, options: dict):
         "%(name)s[graph_, OptionsPattern[%(name)s]]"

pymathics/graph/parametric.py

@@ -86,7 +86,7 @@ class BarbellGraph(_NetworkXBuiltin):
     :Barbell graph:https://en.wikipedia.org/wiki/Barbell_graph
     </url> (
     <url>
-    :NetworkX:https://networkx.org/documentation/stable/reference/\
+    :NetworkX:https://networkx.org/documentation/networkx-2.8.8/reference/\
 generated/networkx.generators.classic.barbell_graph.html</url>
 )
 
@@ -144,7 +144,7 @@ class BinomialTree(_NetworkXBuiltin):
     :Binomial tree:https://en.wikipedia.org/wiki/Binomial_tree
     </url> (
     <url>
-    :NetworkX:https://networkx.org/documentation/stable/reference/\
+    :NetworkX:https://networkx.org/documentation/networkx-2.8.8/reference/\
 generated/networkx.generators.classic.binomial_tree.html</url>,
     <url>
     :WMA:https://reference.wolfram.com/language/ref/BinomialTree.html
@@ -198,6 +198,9 @@ def eval(
 
 class CompleteGraph(_NetworkXBuiltin):
     """
+    <url>
+    :WMA:https://reference.wolfram.com/language/ref/CompleteGraph.html
+    </url>
     <dl>
       <dt>'CompleteGraph[$n$]'
       <dd>Returns the complete graph with $n$ vertices, $K_n$.
@@ -226,7 +229,12 @@ def eval_multipartite(self, n, evaluation: Evaluation, options: dict):
 
 
 class CompleteKaryTree(_NetworkXBuiltin):
-    """<dl>
+    """
+    <url>
+    :K-ary Tree:https://en.wikipedia.org/wiki/M-ary_tree
+    </url>
+
+    <dl>
       <dt>'CompleteKaryTree[$n$, $k$]'
       <dd>Creates a complete $k$-ary tree of $n$ levels.
     </dl>
@@ -269,10 +277,14 @@ def eval_2(self, n, expression, evaluation: Evaluation, options: dict):
 
 
 class CycleGraph(_NetworkXBuiltin):
-    """<dl>
-        <dt>'CycleGraph[$n$]'
-        <dd>Returns the cycle graph with $n$ vertices $C_n$.
-      </dl>
+    """
+    <url>:Cycle Graph:
+    https://en.wikipedia.org/wiki/Cycle_graph</url>
+
+    <dl>
+      <dt>'CycleGraph[$n$]'
+      <dd>Returns the cycle graph with $n$ vertices $C_n$.
+    </dl>
 
     >> CycleGraph[5, PlotLabel -> "C_i"]
      = -Graph-
@@ -289,8 +301,13 @@ def eval(self, n: Integer, expression, evaluation: Evaluation, options: dict):
             return eval_hkn_harary(self, Integer(2), n, expression, evaluation, options)
 
 
+# It seems that this makes the same than CompleteKaryTree
 class FullRAryTree(_NetworkXBuiltin):
     """
+    <url>
+    :K-ary Tree:https://en.wikipedia.org/wiki/M-ary_tree
+    </url>
+
     <dl>
       <dt>'FullRAryTree[$r$, $n$]'
       <dd>Creates a full $r$-ary tree of $n$ vertices.
@@ -321,6 +338,11 @@ def eval(self, r, n, expression, evaluation: Evaluation, options: dict):
 
 class GraphAtlas(_NetworkXBuiltin):
     """
+    <url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference/\
+generated/networkx.generators.atlas.graph_atlas.html
+    </url>
+
     <dl>
       <dt>'GraphAtlas[$n$]'
       <dd>Returns graph number $i$ from the NetworkX's Graph \
@@ -357,6 +379,10 @@ def eval(self, n, expression, evaluation: Evaluation, options: dict):
 
 class HknHararyGraph(_NetworkXBuiltin):
     """
+    <url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference\
+/generated/networkx.generators.harary_graph.hkn_harary_graph.html#hkn-harary-graph
+    </url>
     <dl>
       <dt>'HknHararyGraph[$k$, $n$]'
       <dd>Returns the Harary graph with given node connectivity and node number.
@@ -387,6 +413,10 @@ def eval(self, k, n, expression, evaluation: Evaluation, options: dict):
 
 class HmnHararyGraph(_NetworkXBuiltin):
     """
+    <url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference\
+/generated/networkx.generators.harary_graph.hnm_harary_graph.html
+    </url>
     <dl>
       <dt>'HmnHararyGraph[$m$, $n$]'
       <dd>Returns the Harary graph with given numbers of nodes and edges.
@@ -437,6 +467,11 @@ def eval(self, n, m, expression, evaluation: Evaluation, options: dict):
 
 class KaryTree(_NetworkXBuiltin):
     """
+    <url>
+    :K-ary Tree:https://en.wikipedia.org/wiki/M-ary_tree
+    </url>
+
+
     <dl>
       <dt>'KaryTree[$r$, $n$]'
       <dd>Creates binary tree of $n$ vertices.
@@ -478,6 +513,12 @@ def eval_with_k(
 
 class LadderGraph(_NetworkXBuiltin):
     """
+    <url>
+    :Ladder graph:https://en.wikipedia.org/wiki/Ladder_graph
+    </url>(<url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference\
+/generated/networkx.generators.classic.ladder_graph.html
+    </url>)
     <dl>
       <dt>'LadderGraph[$n$]'
       <dd>Returns the Ladder graph of length $n$.
@@ -514,6 +555,10 @@ def eval(
 
 class PathGraph(_NetworkXBuiltin):
     """
+    <url>
+    :Path graph:https://en.wikipedia.org/wiki/Path_graph
+    </url>(<url>:WMA:https://reference.wolfram.com/language/ref/PathGraph.html
+    </url>)
     <dl>
       <dt>'PathGraph[{$v_1$, $v_2$, ...}]'
       <dd>Returns a Graph with a path with vertices $v_i$ and \
@@ -542,6 +587,10 @@ def edges():
 
 class RandomTree(_NetworkXBuiltin):
     """
+    <url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference\
+/generated/networkx.generators.trees.random_tree.html
+    </url>
     <dl>
       <dt>'RandomTree[$n$]'
       <dd>Returns a uniformly random tree on $n$ nodes.
@@ -578,6 +627,16 @@ def eval(
 
 class StarGraph(_NetworkXBuiltin):
     """
+    <url>
+    :Path graph:https://en.wikipedia.org/wiki/Star_graph
+    </url>(
+    <url>:NetworkX:
+    https://networkx.org/documentation/networkx-2.8.8/reference\
+/generated/networkx.generators.classic.star_graph.html
+    </url>,
+    <url>:WMA:
+    https://reference.wolfram.com/language/ref/StarGraph.html
+    </url>)
     <dl>
       <dt>'StarGraph[$n$]'
       <dd>Returns a star graph with $n$ vertices.