Fixes to previous update from cugraph to cugraph-docs and added back …

…c++ docs (#66) restores the c++ API although breaking it up into groups still needs to be done in a follow-up PR Updates some nx-cugraph docs that didn't get copied correctly in the migration. Authors: - Don Acosta (https://github.com/acostadon) Approvers: - Brad Rees (https://github.com/BradReesWork) URL: #66
rapidsai · Dec 30, 2024 · 21c1bc9 · 21c1bc9
1 parent 1194e74
commit 21c1bc9
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 29 deletions.
diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/centrality.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/centrality.rst
diff --git a/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst b/docs/cugraph-docs/source/api_docs/cugraph_cpp/index.rst
@@ -2,9 +2,5 @@
 cuGraph C++ API documentation
 ===========================
 
-
-.. toctree::
-    :maxdepth: 3
-    :caption: API Documentation
-
-    centrality.rst
+.. doxygennamespace:: cugraph
+   :members:
diff --git a/docs/cugraph-docs/source/graph_support/algorithms.md b/docs/cugraph-docs/source/graph_support/algorithms.md
@@ -50,10 +50,10 @@ Note: Multi-GPU, or MG, includes support for Multi-Node Multi-GPU (also called M
 | Layout            |                                    |                     |                                                                 |
 |                   | [Force Atlas 2](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/layout/Force-Atlas2.ipynb)              | Single-GPU          |        |
 | Linear Assignment |                                    |                     |                                                                 |
-|                   | [Hungarian]()                      | Single-GPU          | [README](cpp/src/linear_assignment/README-hungarian.md)         |
+|                   | [Hungarian]()                      | Single-GPU          | [README](./algorithms/cpp_algorithms/linear_cpp.html)         |
 | Link Analysis     |                                    |                     |                                                                 |
-|                   | [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb)                | __Multi-GPU__ | [C++ README](cpp/src/centrality/README.md#Pagerank)                |
-|                   | [Personal Pagerank]()                  | __Multi-GPU__ | [C++ README](cpp/src/centrality/README.md#Personalized-Pagerank)   |
+|                   | [Pagerank](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/Pagerank.ipynb)                | __Multi-GPU__ | [C++ README](./algorithms/cpp_algorithms/centrality_cpp.html#Pagerank)                |
+|                   | [Personal Pagerank]()                  | __Multi-GPU__ | [C++ README](./algorithms/cpp_algorithms/centrality_cpp.html#Personalized-Pagerank)   |
 |                   | [HITS](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_analysis/HITS.ipynb)        | __Multi-GPU__ |                |
 | [Link Prediction](algorithms/Similarity.html)   |                                    |                     |                                                                 |
 |                   | [Jaccard Similarity](https://github.com/rapidsai/cugraph/blob/main/notebooks/algorithms/link_prediction/Jaccard-Similarity.ipynb)                 | __Multi-GPU__      | Directed graph only                         |
@@ -68,8 +68,8 @@ Note: Multi-GPU, or MG, includes support for Multi-Node Multi-GPU (also called M
 |                   | Node2Vec                           | __Multi-GPU__       |                                             |
 |                   | Neighborhood sampling      | __Multi-GPU__ |                                                                 |
 | Traversal         |                                    |                     |                                                                 |
-|                   | Breadth First Search (BFS)         | __Multi-GPU__ | with cutoff support [C++ README](cpp/src/traversal/README.md#BFS) |
-|                   | Single Source Shortest Path (SSSP) | __Multi-GPU__ | [C++ README](cpp/src/traversal/README.md#SSSP)                     |
+|                   | Breadth First Search (BFS)         | __Multi-GPU__ | with cutoff support [C++ README](./algorithms/cpp_algorithms/traversal_cpp.html#BFS) |
+|                   | Single Source Shortest Path (SSSP) | __Multi-GPU__ | [C++ README](./algorithms/cpp_algorithms/traversal_cpp.html#SSSP)                     |
 |                   | _ASSP / APSP_                    | ---                 |                                                                 |
 | Tree              |                                    |                     |                                                                 |
 |                   | Minimum Spanning Tree              | Single-GPU          |                                                                 |

diff --git a/docs/cugraph-docs/source/graph_support/cugraph_cpp.rst b/docs/cugraph-docs/source/graph_support/cugraph_cpp.rst
@@ -5,4 +5,4 @@ Cugraph C++
 .. toctree::
    :maxdepth: 3
 
-   cugraph_cpp.md
+   cugraph_cpp_support.md
diff --git a/...-docs/source/graph_support/cugraph_cpp.md → ...urce/graph_support/cugraph_cpp_support.md b/...-docs/source/graph_support/cugraph_cpp.md → ...urce/graph_support/cugraph_cpp_support.md
diff --git a/docs/cugraph-docs/source/graph_support/index.rst b/docs/cugraph-docs/source/graph_support/index.rst
@@ -8,6 +8,7 @@ Graph Support
 
    graph_algorithms.rst
    compatibility.rst
+   cugraph_cpp.rst
    gnn_support.rst
    datastores.rst
    cugraph_service.rst
diff --git a/docs/cugraph-docs/source/index.rst b/docs/cugraph-docs/source/index.rst
@@ -9,7 +9,7 @@ RAPIDS Graph documentation
 Introduction
 ~~~~~~~~~~~~
 cuGraph is a library of graph algorithms that seamlessly integrates into the
-RAPIDS data science ecosystem and allows the data scientist to easily call
+RAPIDS data science ecosystem and allows data scientists to easily call
 graph algorithms using data stored in cuDF/Pandas DataFrames or CuPy/SciPy
 sparse matrices.
 
@@ -97,4 +97,4 @@ Indices and tables
 ~~~~~~~~~~~~~~~~~~
 
 * :ref:`genindex`
-* :ref:`search`
+* :ref:`search`