pin Sphinx below 8.2.0

[jameslamb]

Description

Sphinx 8.2.0 was released recently (release notes). nbsphinx is not compatible with it, and so some docs builds across RAPIDS started breaking like this:

AttributeError: module 'sphinx.util' has no attribute 'console'

...

sphinx.errors.ExtensionError: Handler <function html_collect_pages at 0x7f66eddf6a20> for event 'html-collect-pages' threw an exception (exception: module 'sphinx.util' has no attribute 'console')

(example build link from rmm)

That's been reported in spatialaudio/nbsphinx#825

And there are some proposed upstream fixes:

• Add sphinx.util.console import for 8.2.0 compatibility spatialaudio/nbsphinx#827
• Make implicit imports explicit spatialaudio/nbsphinx#826

But to unblock RAPIDS CI, this issue documents the work of pinning to an older sphinx until that upstream issue is resolved.

Benefits of this work

• unblocks RAPIDS CI

Acceptance Criteria

• docs builds are running successfully across RAPIDS

Approach

(GitHub task lists are going away 😭 )

• cucim (require sphinx<8.2.0 cucim#840)
• cudf (not affected - recent successful run)
• cugraph (not affected - recent successful run)
• cugraph-docs (require sphinx<8.2.0, update CODEOWNERS cugraph-docs#100)
• cugraph-gnn (not affected - recent successful run)
• cuml (Require sphinx<8.2.0 cuml#6336)
• cumlprims_mg (not affected - no docs builds)
• cuopt (no docs builds in CI since https://github.com/rapidsai/cuopt/pull/2093)
• cuspatial (not affected - recent successful run)
• cuvs (not affected - recent successful run)
• cuxfilter (require sphinx<8.2.0 cuxfilter#665)
• dask-cuda (not affected - recent successful run)
• dependency-file-generator (not affected - docs builds haven't been added yet: chore(ci): Build docs dependency-file-generator#78)
• jupyterlab-nvdashboard (not affected - no sphinx usage)
• kvikio (not affected - recent successful run)
• legate-boost (not affected - recent build that did not experience this)
• legate-dataframe (require sphinx<8.2.0 legate-dataframe#31)
• legate-raft (probably not affected - checking in MAINT: update rapids-dependency-file-generator to 1.17.1, fix docs builds legate-raft#14)
• nx-cugraph (no pin needed - no docs builds)
  • opened remove docs dependencies nx-cugraph#93 with other cleanup though
• pynvjitlink (not affected - no sphinx usage)
• raft (Require sphinx<8.2.0 raft#2590)
• rmm (Update rattler-build recipe with assorted small fixes rmm#1832)
• ucx-py (require sphinx<8.2.0 ucx-py#1119)
• ucxx (not affected - only doing Doxygen builds, not sphinx - recent successful run)

[bdice]

@jameslamb Let's filter this to only pin sphinx for repositories using nbsphinx. Here is a list:

https://github.com/search?q=org%3Arapidsai+%2F-+nbsphinx%2F+path%3Adependencies.yaml&type=code

[jameslamb]

It's even narrower than that. For example cudf uses nbsphinx but its docs builds are succeeding with sphinx 8.2.0:

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.