Use nvidia-sphinx-theme for docs#528
Merged
rapids-bot[bot] merged 7 commits intoDec 20, 2024
Merged
Conversation
benfred
added
doc
|
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. |
Contributor
Author
|
/ok to test |
nvidia-sphinx-theme calls `sphinx.util.fileutil.copy_asset_file` with a Path - but sphinx v7.* expects a `str` , which causes the build to fail. Require sphinx v8 here to make this work
cjnolet
approved these changes
Dec 12, 2024
the docs build in CI is using an older version of breathe (v4.15.0) - which is from 2020 and doesn't support sphinx v8 (sphinx-doc/sphinx#11490). Fix by requiring the latest version
…into nvidia-sphinx-theme
jameslamb
approved these changes
Dec 12, 2024
Member
There was a problem hiding this comment.
Seems fine to me, glad to see that it's on pypi.org: https://pypi.org/project/nvidia-sphinx-theme/#description
Breathe doesn't fully support sphinx v8 - it raises some warnings in sphinx since its passing a `str` to Sphinx functions that expect a `Path`. This still works for now (will be fully removed in sphinx v9), but is deprecated - which is why breathe indicates it only support sphinx<=v7.2 in conda. However, nvidia-sphinx-theme only works with sphinx v8 afaict, since it is passing a Path to `sphinx.util.fileutil.copy_asset_file` - which breaks on sphinx v7 since it's expecting a `str`. Hack around this dependency issue by installing breathe from pip, which isn't as strict about supported sphinx versions.
Contributor
Author
|
/merge |
rapids-bot Bot
pushed a commit
that referenced
this pull request
Dec 31, 2024
As part of #528 cuvs's doc builds were modified to pull Breathe from pip. That was necessary because the nvidia-sphinx-theme requires Sphinx 8 but [the conda-forge Breathe package was not compatible with that Sphinx version](conda-forge/breathe-feedstock#63). I fixed that in conda-forge/breathe-feedstock#64, so now we can go back to using Breathe from conda to avoid mixing pip and conda for dependency management in the same environment. Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - Bradley Dice (https://github.com/bdice) URL: #554
This was referenced Dec 31, 2024
rapids-bot Bot
pushed a commit
to rapidsai/cugraph-docs
that referenced
this pull request
Jan 7, 2025
**This is exactly the same set of changes already approved in #69.** `cugraph-docs` was switched from private to public during the lifetime of that PR, which put CI into a state where that PR couldn't be merged: #69 (comment) --- Development and the vision for this project has stabilized here quite a bit over the last few weeks, so I think it's a good time to simplify things. This proposes the following: * removing configuration for codecov - *(there are no tests running here)* * removing patterns in CODEOWNERS that don't match any files * removing anything related to CUDA 11, pyproject.toml, or requirements.txt in `dependencies.yaml` and related files - *this repo exclusively uses conda, and only a single major version of CUDA* * updating to `sphinx>=8` and `breathe>=4.35` - *to match the rest of RAPIDS, e.g. rapidsai/cugraph#4839, NVIDIA/cuvs#528 - *floors also mean faster conda solves and fewer surprises at build time* * removing unnecessary files in `ci/utils` - *these appear to have been copied from `cugraph`, but they're not needed as we don't do notebook testing here* ## Notes for Reviewers ### How I tested this Tested the `update-version.sh` changes like this: ```shell ./ci/release/update-version.sh '25.04.00' git grep -E '25\.2' git grep -E '25\.02' ``` Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Don Acosta (https://github.com/acostadon) - Ray Douglass (https://github.com/raydouglass) - Bradley Dice (https://github.com/bdice) URL: #71
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.