Update docs to use NVIDIA Sphinx theme#23035
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughUpdates Sphinx documentation dependencies and configuration to use nvidia-sphinx-theme, adds sidebar navigation templates, and changes a PackedColumns null check in cudf_streaming. ChangesSphinx Theme Migration
PackedColumns Guard Fix
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
0c1d5cc to
d7de68d
Compare
vyasr
left a comment
There was a problem hiding this comment.
Couple of questions about simplifying and documenting the jinja template we're adding, but otherwise looks great. Thanks for figuring this out Bradley!
|
/merge |
- uses `NVIDIA cuDF` for the documentation project and landing-page branding - removes the inactive Twitter/X link and retains the GitHub icon - removes the RAPIDS logo from the landing page so the theme default NVIDIA logo is used - uses `NVIDIA cuDF Documentation` consistently for HTML, LaTeX, man, and Texinfo output Follow-up to rapidsai/build-planning#300 and #23035. ## Validation - Doxygen generation passes - strict Sphinx HTML build passes with `-n -W --keep-going` and notebook execution disabled - the notebook-executing build reaches HTML rendering but the `10min` notebook fails with an unrelated `CUDA_ERROR_ILLEGAL_ADDRESS` in the local GPU environment - targeted pre-commit hooks pass Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Matthew Roeschke (https://github.com/mroeschke) URL: #23079
Description
Updates the cuDF docs to use the NVIDIA Sphinx theme, following the same direction as rapidsai/rmm#2443.
This removes the local RAPIDS custom CSS/JS injection from the Sphinx and Doxygen docs configuration, switches the cuDF and dask-cuDF Sphinx configs to
nvidia_sphinx_theme, and updates docs dependencies frompydata-sphinx-themetonvidia-sphinx-theme.Validation
ast.parse.dependencies.yamland generated conda environment YAML files withyaml.safe_load.RAPIDS dependency file generator.Checklist