Update minimal sphinx theme version so that we can use parallel doc builds #17719
Conversation
vyasr
added
improvement
|
Last night's doc build job took 20 mins: https://github.com/rapidsai/cudf/actions/runs/12703762206/job/35413373935 |
| @@ -49,7 +49,7 @@ popd | |||
|
|
|||
| rapids-logger "Build Python docs" | |||
| pushd docs/cudf | |||
| make dirhtml | |||
| make dirhtml O="-j 8" | |||
There was a problem hiding this comment.
I don't know what O means here. I see a comment in the Makefile, $(O) is meant as a shortcut for $(SPHINXOPTS).. However, I think it's needlessly confusing to use a single character variable for this purpose. We should write SPHINXOPTS directly for clarity, or use a different name like PARALLEL_LEVEL and wire that through the Makefile.
| make dirhtml O="-j 8" | |
| make dirhtml SPHINXOPTS="-j 8 -n -v -W --keep-going" |
| @@ -618,8 +618,10 @@ dependencies: | |||
| - nbsphinx | |||
| - numpydoc | |||
| - pandoc | |||
| # https://github.com/pydata/pydata-sphinx-theme/issues/1539 | |||
| - pydata-sphinx-theme!=0.14.2 | |||
| # Minimum version for safe parallel writing again. | |||
There was a problem hiding this comment.
It seems like we may also need sphinx>=8.1? That is the minimum Sphinx version to get sphinx-doc/sphinx#12888, which is referenced in pydata/pydata-sphinx-theme#1859 (as "the bug is really in Sphinx").
...and this one took 9m 47s! https://github.com/rapidsai/cudf/actions/runs/12719918991/job/35462058334?pr=17719 Success! |
Description
Based on my previous data from #14856 adding parallelism should substantially improve doc build times, and the upstream issue blocking that has been resolved now.
Checklist