Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update minimal sphinx theme version so that we can use parallel doc builds #17719

Open
wants to merge 2 commits into
base: branch-25.02
Choose a base branch
from
+8 −6
Open

Update minimal sphinx theme version so that we can use parallel doc builds #17719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45866fb
Update minimal sphinx theme version so that we can use parallel doc b…
vyasr Jan 11, 2025
aa005c4
Build in parallel
vyasr Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ci/build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
# Copyright (c) 2023-2024, NVIDIA CORPORATION.
# Copyright (c) 2023-2025, NVIDIA CORPORATION.

set -euo pipefail

Expand Down Expand Up @@ -49,7 +49,7 @@ popd

rapids-logger "Build Python docs"
pushd docs/cudf
make dirhtml
make dirhtml O="-j 8"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
make dirhtml O="-j 8"
make dirhtml SPHINXOPTS="-j 8 -n -v -W --keep-going"

mkdir -p "${RAPIDS_DOCS_DIR}/cudf/html"
mv build/dirhtml/* "${RAPIDS_DOCS_DIR}/cudf/html"
popd
Expand Down
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-118_arch-x86_64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ dependencies:
- pre-commit
- ptxcompiler
- pyarrow>=14.0.0,<19.0.0a0
- pydata-sphinx-theme!=0.14.2
- pydata-sphinx-theme>=0.15.4
- pynvml>=12.0.0,<13.0.0a0
- pytest-benchmark
- pytest-cases>=3.8.2
Expand Down
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-125_arch-x86_64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ dependencies:
- polars>=1.11,<1.18
- pre-commit
- pyarrow>=14.0.0,<19.0.0a0
- pydata-sphinx-theme!=0.14.2
- pydata-sphinx-theme>=0.15.4
- pynvjitlink>=0.0.0a0
- pynvml>=12.0.0,<13.0.0a0
- pytest-benchmark
Expand Down
6 changes: 4 additions & 2 deletions dependencies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

# https://github.com/pydata/pydata-sphinx-theme/pull/1859
# https://github.com/pydata/pydata-sphinx-theme/releases/tag/v0.15.4
- pydata-sphinx-theme>=0.15.4
- scipy
- sphinx
- sphinx-autobuild
Expand Down
Loading