C++ rst files

rapidsai · Sep 17, 2023 · bd54c00 · bd54c00
1 parent 8109f7f
commit bd54c00
Show file tree

Hide file tree

Showing 13 changed files with 151 additions and 177 deletions.
diff --git a/cpp/include/cugraph/algorithms.hpp b/cpp/include/cugraph/algorithms.hpp
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst b/docs/cugraph/source/api_docs/cugraph_cpp/centrality.rst
@@ -1,45 +1,12 @@
 Centrality
 ==========
 
-PageRank
---------
-.. doxygenfunction:: cugraph::pagerank
-    :project: libcugraph
+Centrality Functions
+--------------------
+ .. doxygengroup:: centralityCPP
+     :project: libcugraph
+     :members:
+     :content-only:
 
-.. doxygenfunction:: cugraph::pagerank_allow_nonconvergence
-    :project: libcugraph
-
-Personalized PageRank
----------------------
-.. doxygenfunction:: cugraph::personalized_pagerank
-    :project: libcugraph
-
-.. doxygenfunction:: cugraph::personalized_pagerank_allow_nonconvergence
-    :project: libcugraph
-
-Eigenvector Centrality
-----------------------
-.. doxygenfunction:: cugraph::eigenvector_centrality
-    :project: libcugraph
-
-Katz Centrality
----------------
-.. doxygenfunction:: cugraph::katz_centrality
-    :project: libcugraph
-
-Betweenness Centrality
-----------------------
-.. doxygenfunction:: cugraph::betweenness_centrality
-    :project: libcugraph
-
-Edge Betweenness Centrality
----------------------------
-.. doxygenfunction:: cugraph::edge_betweenness_centrality
-    :project: libcugraph
-
-HITS Centrality
----------------
-.. doxygenfunction:: cugraph::hits
-    :project: libcugraph
 
 
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/community.rst b/docs/cugraph/source/api_docs/cugraph_cpp/community.rst
@@ -1,56 +1,11 @@
 Community
 =========
 
-.. role:: C++(code)
-   :language: cpp
-   :class: highlight
-
 ``#include <cugraph/algorithms.hpp>``
 
-Triangle Counting
------------------
-.. doxygenfunction:: cugraph::triangle_count
-    :project: libcugraph
-
-Louvain
--------
-.. doxygenfunction:: cugraph::louvain
-    :project: libcugraph
-
-Leiden
-------
-.. doxygenfunction:: cugraph::leiden
-    :project: libcugraph
-
-ECG
----
-.. doxygenfunction:: cugraph::ecg
-    :project: libcugraph
-
-Extract Egonet
---------------
-.. doxygenfunction:: cugraph::extract_ego
-    :project: libcugraph
-
-Balanced Cut
-------------
-.. doxygenfunction:: cugraph::balanced_cut_clustering
-    :project: libcugraph
-
-Spectral Clustering - Modularity Maximization
----------------------------------------------
-.. doxygenfunction:: cugraph::spectral_modularity_maximization
-    :project: libcugraph
-
-.. doxygenfunction:: cugraph::analyze_clustering_modularity
-    :project: libcugraph
-
-Spectral Clusteriong - Edge Cut
--------------------------------
-.. doxygenfunction:: cugraph::analyze_clustering_edge_cut
-    :project: libcugraph
-
-.. doxygenfunction:: cugraph::analyze_clustering_ratio_cut
-    :project: libcugraph
-
-
+Community Functions
+-------------------
+ .. doxygengroup:: communityCPP
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/components.rst b/docs/cugraph/source/api_docs/cugraph_cpp/components.rst
@@ -0,0 +1,10 @@
+Components
+==========
+
+
+Components Functions
+--------------------
+ .. doxygengroup:: labelingCPP
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/core.rst b/docs/cugraph/source/api_docs/cugraph_cpp/core.rst
@@ -1,14 +1,12 @@
 Core
 ====
 
-
-Core Number
------------
-.. doxygenfunction:: cugraph::core_number
-    :project: libcugraph
-
-K-Core
-------
-.. doxygenfunction:: cugraph::k_core
-    :project: libcugraph
+``#include <cugraph/algorithms.hpp>``
+
+Core Functions
+--------------
+ .. doxygengroup:: coreCPP
+     :project: libcugraph
+     :members:
+     :content-only:
 
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/index.rst b/docs/cugraph/source/api_docs/cugraph_cpp/index.rst
@@ -9,8 +9,11 @@ cuGraph C++ API documentation
 
     centrality.rst
     community.rst
+    components.rst
     core.rst
-    labeling.rst
+    layout.rst
+    linear_assignment.rst
     sampling.rst
     similarity.rst
     traversal.rst
+    tree.rst
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst b/docs/cugraph/source/api_docs/cugraph_cpp/labeling.rst
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst b/docs/cugraph/source/api_docs/cugraph_cpp/layoyt.rst
@@ -0,0 +1,12 @@
+Core
+====
+
+``#include <cugraph/algorithms.hpp>``
+
+Core Functions
+--------------
+ .. doxygengroup:: placementCPP
+     :project: libcugraph
+     :members:
+     :content-only:
+
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst b/docs/cugraph/source/api_docs/cugraph_cpp/linear_assignment.rst
@@ -0,0 +1,12 @@
+Linear Assignment
+=================
+
+Linear Assignment Functions
+---------------------------
+ .. doxygengroup:: assignmentCPP
+     :project: libcugraph
+     :members:
+     :content-only:
+
+
+
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst b/docs/cugraph/source/api_docs/cugraph_cpp/sampling.rst
@@ -1,31 +1,9 @@
 Sampling
 ========
 
-Uniform Random Walks
---------------------
-.. doxygenfunction:: cugraph::uniform_random_walks
-    :project: libcugraph
-
-Biased Random Walks
---------------------
-.. doxygenfunction:: cugraph::biased_random_walks
-    :project: libcugraph
-
-Random Walks via Node2Vec
--------------------------
-.. doxygenfunction:: cugraph::node2vec_random_walks
-    :project: libcugraph
-
-Node2Vec
---------
-.. doxygenfunction:: cugraph::node2vec
-    :project: libcugraph
-
-Uniform Neighborhood Sampling
------------------------------
-.. doxygenfunction:: cugraph::uniform_neighbor_sample_with_edge_properties
-    :project: libcugraph
-
-.. doxygenfunction:: cugraph::uniform_neighbor_sample
-    :project: libcugraph
-
+Sampling Functions
+------------------
+ .. doxygengroup:: samplingCPPs
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst b/docs/cugraph/source/api_docs/cugraph_cpp/similarity.rst
@@ -1,18 +1,9 @@
 Similarity
 ==========
 
-
-Jaccard
--------
-.. doxygenfunction:: cugraph::jaccard_coefficients
-    :project: libcugraph
-
-Sorensen
---------
-.. doxygenfunction:: cugraph::sorensen_coefficients
-    :project: libcugraph
-
-Overlap
--------
-.. doxygenfunction:: cugraph::overlap_coefficients
-    :project: libcugraph
+Similarity Functions
+--------------------
+ .. doxygengroup:: similarityCPP
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst b/docs/cugraph/source/api_docs/cugraph_cpp/traversal.rst
@@ -2,22 +2,9 @@ Traversal
 ==========
 
 
-Breadth First Search (BFS)
---------------------------
-.. doxygenfunction:: cugraph::bfs
-    :project: libcugraph
-
-Single-Source Shortest-Path (SSSP)
-----------------------------------
-.. doxygenfunction:: cugraph::sssp
-    :project: libcugraph
-
-Path Extraction
----------------
-.. doxygenfunction:: cugraph::extract_paths
-    :project: libcugraph
-
-Extract Max Path Length
------------------------
-.. doxygenfunction:: cugraph::extract_paths_result_get_max_path_length
-    :project: libcugraph
+Traversal Functions
+-------------------
+ .. doxygengroup:: traversalCPP
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_cpp/tree.rst b/docs/cugraph/source/api_docs/cugraph_cpp/tree.rst
@@ -0,0 +1,10 @@
+Tree
+====
+
+
+Tree Functions
+--------------
+ .. doxygengroup:: treeCPP
+     :project: libcugraph
+     :members:
+     :content-only: