Document clique counting

Author: FlorentinD

doc/sphinx/algorithms.json

@@ -3593,5 +3593,37 @@
       "return_type": "float"
     },
     "description": "Given two nodes, calculate Total Neighbors"
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.mutate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "DataFrame"
+    },
+    "description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.stats",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "DataFrame"
+    },
+    "description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.stream",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "DataFrame"
+    },
+    "description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.write",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "DataFrame"
+    },
+    "description": "The Clique Counting algorithm count the number of cliques of each size for every node in the graph."
   }
 ]

doc/sphinx/create_algorithms_rst.py

@@ -1,7 +1,12 @@
 import json
+import os
+from pathlib import Path
 from textwrap import dedent
 
-with open("algorithms.json") as f, open("source/algorithms.rst", "w") as fw:
+root_dir = Path(__file__).parent
+
+
+with open(root_dir / "algorithms.json") as f, open(root_dir / "source/algorithms.rst", "w") as fw:
     functions = json.load(f)
 
     fw.write(

doc/sphinx/source/algorithms.rst

@@ -1989,3 +1989,19 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Given two nodes, calculate Total Neighbors
 
+.. py:function:: gds.cliqueCounting.mutate(G: Graph, **config: Any) -> DataFrame
+
+    The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
+
+.. py:function:: gds.cliqueCounting.stats(G: Graph, **config: Any) -> DataFrame
+
+    The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
+
+.. py:function:: gds.cliqueCounting.stream(G: Graph, **config: Any) -> DataFrame
+
+    The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
+
+.. py:function:: gds.cliqueCounting.write(G: Graph, **config: Any) -> DataFrame
+
+    The Clique Counting algorithm count the number of cliques of each size for every node in the graph.
+