Add sphinx-lint pre-commit and some docs fixes (#4771)

I noticed the `Traversals` table is not showing up in the [nx-cugraph docs](https://docs.rapids.ai/api/cugraph/stable/nx_cugraph/supported-algorithms/). `sphinx-lint` catches the underlying issue, and it also caught a couple other minor issues that this PR fixes. `sphinx-lint` is used by other notable repos such as `pandas` ([here](https://github.com/pandas-dev/pandas/blob/7fe270c8e7656c0c187260677b3b16a17a1281dc/.pre-commit-config.yaml#L92-L96)] and CPython ([here](https://github.com/python/cpython/blob/8fe1926164932f868e6e907ad72a74c2f2372b07/.pre-commit-config.yaml#L68-L73)) Authors: - Erik Welch (https://github.com/eriknw) Approvers: - Jake Awe (https://github.com/AyodeAwe) - Ralph Liu (https://github.com/nv-rliu) - Rick Ratzel (https://github.com/rlratzel) URL: #4771
rapidsai · Nov 25, 2024 · 3d681cc · 3d681cc
1 parent 8388aca
commit 3d681cc
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -53,6 +53,11 @@ repos:
               meta[.]yaml$|
               setup[.]cfg$
       - id: verify-alpha-spec
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.0
+    hooks:
+      - id: sphinx-lint
+        args: ["--enable=all", "--disable=line-too-long"]
   - repo: https://github.com/rapidsai/dependency-file-generator
     rev: v1.16.0
     hooks:

diff --git a/docs/cugraph/source/api_docs/cugraph-ops/index.rst b/docs/cugraph/source/api_docs/cugraph-ops/index.rst
@@ -1,7 +1,7 @@
 cugraph-ops API reference
 =========================
 
-This page provides a list of all publicly accessible modules, methods and classes through `pylibcugraphops.*` namespace.
+This page provides a list of all publicly accessible modules, methods and classes through ``pylibcugraphops.*`` namespace.
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/cugraph/source/api_docs/cugraph-ops/python/index.rst b/docs/cugraph/source/api_docs/cugraph-ops/python/index.rst
@@ -1,7 +1,7 @@
 cugraph-ops Python API reference
 ================================
 
-This page provides a list of all publicly accessible modules, methods and classes through `pylibcugraphops.*` namespace.
+This page provides a list of all publicly accessible modules, methods and classes through ``pylibcugraphops.*`` namespace.
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/cugraph/source/nx_cugraph/index.rst b/docs/cugraph/source/nx_cugraph/index.rst
@@ -49,7 +49,7 @@ Users can have GPU-based, large-scale performance **without** changing their fam
 +--------------------------------------------------------------------------------------------------------+
 | **Run the same code on CPU or GPU**                                                                    |
 |                                                                                                        |
-| Nothing changes, not even your `import` statements, when going from CPU to GPU.                        |
+| Nothing changes, not even your ``import`` statements, when going from CPU to GPU.                      |
 +--------------------------------------------------------------------------------------------------------+
 
 

diff --git a/docs/cugraph/source/nx_cugraph/supported-algorithms.rst b/docs/cugraph/source/nx_cugraph/supported-algorithms.rst
@@ -180,7 +180,7 @@ Algorithms
 +---------------------------------------+
 
 +---------------------------+
-| **Traversal**       		|
+| **Traversal**             |
 +===========================+
 | bfs_edges                 |
 +---------------------------+

diff --git a/docs/cugraph/source/tutorials/cugraph_blogs.rst b/docs/cugraph/source/tutorials/cugraph_blogs.rst
@@ -65,9 +65,9 @@ Academic Papers
 
  * Alex Fender, Brad Rees, Joe Eaton (2022) `Massive Graph Analytics <https://books.google.com/books?hl=en&lr=&id=QspxEAAAQBAJ&oi=fnd&pg=PT8&dq=book:%22Massive+Graph+Analytics%22&ots=3HAGJ0njKO&sig=8e4v0azmzA6LTQNUNgPw-uTLkoc#v=onepage&q&f=false>`_  Bader, D. (Editor) CRC Press
 
- * S Kang, A. Fender, J. Eaton, B. Rees:`Computing PageRank Scores of Web Crawl Data Using DGX A100 Clusters`. In IEEE HPEC, Sep. 2020
+ * S Kang, A. Fender, J. Eaton, B. Rees. `Computing PageRank Scores of Web Crawl Data Using DGX A100 Clusters <https://ieeexplore.ieee.org/abstract/document/9286216>`_. In IEEE HPEC, Sep. 2020
 
- * Hricik, T., Bader, D., & Green, O. (2020, September). `Using RAPIDS AI to accelerate graph data science workflows`. In 2020 IEEE High Performance Extreme Computing Conference (HPEC) (pp. 1-4). IEEE.
+ * Hricik, T., Bader, D., & Green, O. (2020, September). `Using RAPIDS AI to accelerate graph data science workflows <https://ieeexplore.ieee.org/abstract/document/9286224>`_. In 2020 IEEE High Performance Extreme Computing Conference (HPEC) (pp. 1-4). IEEE.
 
  * Richardson, B., Rees, B., Drabas, T., Oldridge, E., Bader, D. A., & Allen, R. (2020, August). Accelerating and Expanding End-to-End Data Science Workflows with DL/ML Interoperability Using RAPIDS. In Proceedings of the 26th ACM SIGKDD International Conference on Knowledge Discovery & Data Mining (pp. 3503-3504).