Add sphinx-lint pre-commit and some docs fixes #4771
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
AyodeAwe
approved these changes
Nov 18, 2024
nv-rliu
approved these changes
Nov 18, 2024
eriknw
added
bug
rlratzel
approved these changes
Nov 19, 2024
rapids-bot bot
pushed a commit
to rapidsai/nx-cugraph
that referenced
this pull request
Nov 20, 2024
Companion PR to rapidsai/cugraph#4771, because if we want `sphinx-lint` pre-commit there, then we probably want it here too. The docs in this repo are out of date and were updated to make `sphinx-lint` happy. Authors: - Erik Welch (https://github.com/eriknw) - Ralph Liu (https://github.com/nv-rliu) Approvers: - Rick Ratzel (https://github.com/rlratzel) - Bradley Dice (https://github.com/bdice) URL: #29
|
/merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed the
Traversalstable is not showing up in the nx-cugraph docs.sphinx-lintcatches the underlying issue, and it also caught a couple other minor issues that this PR fixes.sphinx-lintis used by other notable repos such aspandas(here] and CPython (here)