Skip to content

WIP: [NOT READY FOR REVIEW] enforce 'rstcheck' checks, treat warnings as errors #214

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

Draft
jameslamb wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WIP: [NOT READY FOR REVIEW] enforce 'rstcheck' checks, treat warnings as errors #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0a1775
enforce 'rstcheck' checks
jameslamb Aug 5, 2026
8af592c
enable warnings-as-errors too
jameslamb Aug 5, 2026
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
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ repos:
- id: codespell
additional_dependencies: [tomli]
args: ["--toml", "pyproject.toml"]
- repo: https://github.com/rstcheck/rstcheck
rev: v6.2.5
hooks:
- id: rstcheck
args: ["--config", "pyproject.toml"]
additional_dependencies:
- 'rstcheck[sphinx,toml]'
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.11.0.1
hooks:
Expand Down
4 changes: 3 additions & 1 deletion docs/cugraph-docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS = "-v"
SPHINXOPTS = "-v -W"
SPHINXBUILD = sphinx-build
SPHINXPROJ = cugraph
SOURCEDIR = source
Expand Down
3 changes: 3 additions & 0 deletions docs/cugraph-docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
REM Copyright (c) 2024-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

@ECHO OFF

pushd %~dp0
Expand All @@ -9,6 +11,7 @@ if "%SPHINXBUILD%" == "" (
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXOPTS=-v -W
set SPHINXPROJ=cuGraph

if "%1" == "" goto help
Expand Down
21 changes: 7 additions & 14 deletions docs/cugraph-docs/source/api_docs/cugraph/centrality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,15 @@ Centrality
Betweenness Centrality
----------------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.centrality.betweenness_centrality
cugraph.centrality.edge_betweenness_centrality

multi-GPU
^^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -31,16 +29,14 @@ multi-GPU
Katz Centrality
---------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.centrality.katz_centrality

multi-GPU
^^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -51,8 +47,7 @@ multi-GPU
Degree Centrality
-----------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -63,16 +58,14 @@ single-GPU
Eigenvector Centrality
----------------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.centrality.eigenvector_centrality

multi-GPU
^^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand Down
42 changes: 14 additions & 28 deletions docs/cugraph-docs/source/api_docs/cugraph/community.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@ Community
EgoNet
------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.ego_graph

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -28,16 +26,14 @@ multi-GPU
Ensemble clustering for graphs (ECG)
------------------------------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.ecg

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -47,17 +43,15 @@ multi-GPU
K-Truss
-------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.k_truss
cugraph.ktruss_subgraph

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -68,16 +62,14 @@ multi-GPU
Leiden
------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.leiden

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -87,17 +79,15 @@ multi-GPU
Louvain
-------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.louvain


multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -120,16 +110,14 @@ Spectral Clustering
Induced Subgraph
----------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.induced_subgraph

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -139,16 +127,14 @@ multi-GPU
Triangle Counting
-----------------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.triangle_count

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand Down
12 changes: 4 additions & 8 deletions docs/cugraph-docs/source/api_docs/cugraph/cores.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@ Cores
Core Number
-----------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.core_number

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -29,16 +27,14 @@ multi-GPU
K-Core
------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.k_core

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand Down
3 changes: 0 additions & 3 deletions docs/cugraph-docs/source/api_docs/cugraph/graph_implementation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ Graph Implementation
.. currentmodule:: cugraph.structure.graph_implementation.simpleGraphImpl


Graph Implementation
--------------------

.. autosummary::
:toctree: ../api/cugraph/

Expand Down
12 changes: 4 additions & 8 deletions docs/cugraph-docs/source/api_docs/cugraph/link_analysis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@ Link Analysis
HITS
----

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.hits

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand All @@ -28,16 +26,14 @@ multi-GPU
Pagerank
--------

single-GPU
^^^^^^^^^^
.. rubric:: single-GPU

.. autosummary::
:toctree: ../api/cugraph/

cugraph.pagerank

multi-GPU
^^^^^^^^^
.. rubric:: multi-GPU

.. autosummary::
:toctree: ../api/cugraph/
Expand Down
Loading