Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Nov 25, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8de3a0d
Add sphinx-lint pre-commit and some docs fixes
eriknw Nov 18, 2024
4c302ff
Merge branch 'branch-24.12' into add-sphinx-lint
eriknw Nov 18, 2024
dd47aa3
Merge branch 'branch-24.12' into add-sphinx-lint
eriknw Nov 20, 2024
552421b
Merge branch 'branch-24.12' into add-sphinx-lint
eriknw Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/cugraph/source/api_docs/cugraph-ops/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/cugraph/source/api_docs/cugraph-ops/python/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/cugraph/source/nx_cugraph/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
+--------------------------------------------------------------------------------------------------------+


Expand Down
2 changes: 1 addition & 1 deletion docs/cugraph/source/nx_cugraph/supported-algorithms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Algorithms
+---------------------------------------+

+---------------------------+
| **Traversal** |
| **Traversal** |
+===========================+
| bfs_edges |
+---------------------------+
Expand Down
4 changes: 2 additions & 2 deletions docs/cugraph/source/tutorials/cugraph_blogs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Loading