From 8de3a0d59d1f94519a50b2060c0743b73fbcaf88 Mon Sep 17 00:00:00 2001 From: Erik Welch Date: Mon, 18 Nov 2024 09:46:01 -0600 Subject: [PATCH] Add sphinx-lint pre-commit and some docs fixes I noticed the `Traversals` table is not showing up in the nx-cugraph docs. `sphinx-lint` catches the underlying issue, and it also caught a couple other minor issues that this PR fixes. --- .pre-commit-config.yaml | 5 +++++ docs/cugraph/source/api_docs/cugraph-ops/index.rst | 2 +- docs/cugraph/source/api_docs/cugraph-ops/python/index.rst | 2 +- docs/cugraph/source/nx_cugraph/index.rst | 2 +- docs/cugraph/source/nx_cugraph/supported-algorithms.rst | 2 +- docs/cugraph/source/tutorials/cugraph_blogs.rst | 4 ++-- 6 files changed, 11 insertions(+), 6 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4bb037b5fda..28f83a967c7 100644 --- 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 index 0f6a6c937d3..41ae9416520 100644 --- 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 index fb25f2fa005..f1f332cb01f 100644 --- 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 index 50565c805a9..0eb8907b397 100644 --- 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 index 8f57c02b240..b984af5abb1 100644 --- 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 index 3665f425e3f..57fa011ab59 100644 --- 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 `_ 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 `_. 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 `_. 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).