pin Sphinx below 8.2.0 #155
Comments
|
@jameslamb Let's filter this to only pin https://github.com/search?q=org%3Arapidsai+%2F-+nbsphinx%2F+path%3Adependencies.yaml&type=code |
|
It's even narrower than that. For example https://github.com/rapidsai/cudf/actions/runs/13446743133/job/37575505715?pr=18058#step:10:6197 That list in the issue isn't a list of repos to change, it's a list of repos to check. I'm not just going to blanket-update them for places that don't need it, I promise. |
Contributes to rapidsai/build-planning#155 Fixes docs builds by temporarily putting a ceiling on `sphinx`. Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) - Don Acosta (https://github.com/acostadon) URL: #100
Contributes to rapidsai/build-planning#155 Fixes docs builds by temporarily putting a ceiling on `sphinx`. Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) URL: #665
Contributes to rapidsai/build-planning#155 Fixes docs builds by temporarily putting a ceiling on `sphinx`. Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) URL: #840
Contributes to rapidsai/build-planning#155 Fixes docs builds by temporarily putting a ceiling on `sphinx`. ## Notes for Reviewers In case you're wondering why you don't see `dependencies.yaml` changes... this project uses readthedocs to builds its docs. * builds: https://app.readthedocs.org/projects/ucx-py/builds/ * config: https://github.com/rapidsai/ucx-py/blob/674e731c21e3a85045239a943248b23dab019619/.readthedocs.yml#L16-L17 Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) URL: #1119
While working on rapidsai/build-planning#155, I realized that this repo no longer has any docs builds. As far as I can tell, it's just relying on `cugraph-docs` to build and publish its docs: * https://github.com/rapidsai/cugraph-docs/tree/branch-25.04/docs/cugraph-docs/source/nx_cugraph If I'm right about that, then this repo doesn't need any `dependencies.yaml` entries for `sphinx` and related dependencies. This proposes removing those, along with other configuration that looks unused (possibly left-over from when this was ported out of https://github.com/rapidsai/cugraph). ## Notes for Reviewers It looks to me like`nx-cugraph` API docs are missing, maybe unintentionally. Opened rapidsai/cugraph-docs#101 to discuss that. I think this PR can be merged without a resolution to that conversation... if we want them, we'd likely build those docs with `sphinx.ext.autosummary` as is done for other Python docs there ([example for cugraph](https://github.com/rapidsai/cugraph-docs/blob/debf03cdb5e549b66a6f3b75d95ec836a159ea33/docs/cugraph-docs/source/api_docs/cugraph/tree.rst?plain=1#L17)). Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Jake Awe (https://github.com/AyodeAwe) - Erik Welch (https://github.com/eriknw) URL: #93
|
While working through this, @seberg found one other way Where those documents had references like
example: rapidsai/legate-raft#14 (comment) Not sure what the root cause was, but pinning back to |
|
This is done, thanks everyone. |
Description
Sphinx 8.2.0 was released recently (release notes).
nbsphinxis not compatible with it, and so some docs builds across RAPIDS started breaking like this:(example build link from rmm)
That's been reported in spatialaudio/nbsphinx#825
And there are some proposed upstream fixes:
But to unblock RAPIDS CI, this issue documents the work of pinning to an older
sphinxuntil that upstream issue is resolved.Benefits of this work
Acceptance Criteria
Approach
(GitHub task lists are going away 😭 )
sphinxusage)sphinxusage)The text was updated successfully, but these errors were encountered: