This is an automated email from the ASF dual-hosted git repository.
ruifengz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new 416b7b1cd5a6 [SPARK-46715][INFRA] Pin `sphinxcontrib-*`
416b7b1cd5a6 is described below
commit 416b7b1cd5a6555a2d545d2f8f3cbd6cadff130e
Author: Ruifeng Zheng <ruife...@apache.org>
AuthorDate: Mon Jan 15 12:00:26 2024 +0800
[SPARK-46715][INFRA] Pin `sphinxcontrib-*`
### What changes were proposed in this pull request?
Pin
- `sphinxcontrib-applehelp==1.0.4`
- `sphinxcontrib-devhelp==1.0.2`
- `sphinxcontrib-htmlhelp==2.0.1`
- `sphinxcontrib-qthelp==1.0.3`
- `sphinxcontrib-serializinghtml==1.1.5`
previously,
`Install Python linter dependencies` install
`sphinxcontrib-applehelp-1.0.7`, and then `Install dependencies for
documentation generation` reinstall it with `sphinxcontrib-applehelp-1.0.4`;
now,
`Install Python linter dependencies` install
`sphinxcontrib-applehelp-1.0.8`, and `Install dependencies for documentation
generation` keep this intallation:
`Requirement already satisfied: sphinxcontrib-applehelp in
/usr/local/lib/python3.9/dist-packages (from sphinx==4.5.0) (1.0.8)`
### Why are the changes needed?
doc build is failing with:
```
Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least
Sphinx v5.0; it therefore cannot be built with this version.
make: *** [Makefile:35: html] Error 2
------------------------------------------------
Jekyll 4.3.3 Please append `--trace` to the `build` command
for any additional information or backtrace.
------------------------------------------------
/__w/spark/spark/docs/_plugins/copy_api_dirs.rb:131:in `<top (required)>':
Python doc generation failed (RuntimeError)
from
/__w/spark/spark/docs/.local_ruby_bundle/ruby/2.7.0/gems/jekyll-4.3.3/lib/jekyll/external.rb:57:in
`require'
from
/__w/spark/spark/docs/.local_ruby_bundle/ruby/2.7.0/gems/jekyll-4.3.3/lib/jekyll/external.rb:57:in
`block in require_with_graceful_fail'
```
```
Sphinx version error:
The sphinxcontrib.devhelp extension used by this project needs at least
Sphinx v5.0; it therefore cannot be built with this version.
make: *** [Makefile:35: html] Error 2
------------------------------------------------
Jekyll 4.3.3 Please append `--trace` to the `build` command
for any additional information or backtrace.
------------------------------------------------
/__w/spark/spark/docs/_plugins/copy_api_dirs.rb:131:in `<top (required)>':
Python doc generation failed (RuntimeError)
```
### Does this PR introduce _any_ user-facing change?
no
### How was this patch tested?
ci
### Was this patch authored or co-authored using generative AI tooling?
no
Closes #44727 from zhengruifeng/infra_pin_sphinxcontrib-applehelp.
Authored-by: Ruifeng Zheng <ruife...@apache.org>
Signed-off-by: Ruifeng Zheng <ruife...@apache.org>
---
.github/workflows/build_and_test.yml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/build_and_test.yml
b/.github/workflows/build_and_test.yml
index 089a9296bcc4..40bcf734c6af 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -753,7 +753,8 @@ jobs:
Rscript -e "devtools::install_version('preferably', version='0.4',
repos='https://cloud.r-project.org')"
- name: Install dependencies for documentation generation
run: |
- python3.9 -m pip install 'sphinx==4.5.0' mkdocs
'pydata_sphinx_theme>=0.13' sphinx-copybutton nbsphinx numpydoc jinja2
markupsafe 'pyzmq<24.0.0'
+ # Should unpin 'sphinxcontrib-*' after upgrading sphinx>5
+ python3.9 -m pip install 'sphinx==4.5.0' mkdocs
'pydata_sphinx_theme>=0.13' sphinx-copybutton nbsphinx numpydoc jinja2
markupsafe 'pyzmq<24.0.0' 'sphinxcontrib-applehelp==1.0.4'
'sphinxcontrib-devhelp==1.0.2' 'sphinxcontrib-htmlhelp==2.0.1'
'sphinxcontrib-qthelp==1.0.3' 'sphinxcontrib-serializinghtml==1.1.5'
python3.9 -m pip install ipython_genutils # See SPARK-38517
python3.9 -m pip install sphinx_plotly_directive 'numpy>=1.20.0'
pyarrow pandas 'plotly>=4.8'
python3.9 -m pip install 'docutils<0.18.0' # See SPARK-39421
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
