Skip to content

Commit f2dd0b3

Browse files
wayneguowHyukjinKwon
authored andcommitted
[SPARK-48848][PYTHON][DOCS] Set the upper bound version of sphinxcontrib-* in dev/requirements.txt with sphinx==4.5.0
### What changes were proposed in this pull request? This PR aims to set the upper bound version of 'sphinxcontrib-*' in `dev/requirements.txt` with `sphinx==4.5.0`. ### Why are the changes needed? Currently, if Spark developers use the command `pip install --upgrade -r dev/requirements.txt` directly to install python-related dependencies, the automatically installed `sphinxcontrib-*` versions don't match `sphinx==4.5.0`. Refered to the issue: sphinx-doc/sphinx#11890. Then they execute the `make html` command for building pySpark docs and the following error will appear: <img width="1211" alt="image" src="https://github.com/apache/spark/assets/16032294/719c4b1d-9b7d-4ba9-89c5-ec3c0dc4572f"> This problem has been avoided through pinning `sphinxcontrib-*` in workflows of Spark GA: ![image](https://github.com/apache/spark/assets/16032294/bf4906f1-a76d-47bd-af42-f263537f371c) So we can do the similar way by setting the upper bound version of in `requirements.txt` and it will be helpful for Spark developers when making pySpark docs. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Pass GA. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #47270 from wayneguow/py_require. Authored-by: Wei Guo <guow93@gmail.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
1 parent b13fc16 commit f2dd0b3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

dev/requirements.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ nbsphinx
3737
numpydoc
3838
jinja2
3939
sphinx==4.5.0
40+
# With sphinx 4.5.0, we need to set the upperbound version of sphinxcontrib*, it should be removed after upgrading sphinx>=5
41+
sphinxcontrib-applehelp<=1.0.4
42+
sphinxcontrib-devhelp<=1.0.2
43+
sphinxcontrib-htmlhelp<=2.0.1
44+
sphinxcontrib-jsmath<=1.0.1
45+
sphinxcontrib-qthelp<=1.0.3
46+
sphinxcontrib-serializinghtml<=1.1.5
4047
sphinx-plotly-directive
4148
sphinx-copybutton
4249
docutils<0.18.0

0 commit comments

Comments
 (0)