You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2024/07/10 07:37:56 UTC
(spark) branch master updated: [SPARK-48848][PYTHON][DOCS] Set the upper bound version of `sphinxcontrib-*` in `dev/requirements.txt` with `sphinx==4.5.0`
This is an automated email from the ASF dual-hosted git repository.
gurwls223 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 f2dd0b3338a6 [SPARK-48848][PYTHON][DOCS] Set the upper bound version of `sphinxcontrib-*` in `dev/requirements.txt` with `sphinx==4.5.0`
f2dd0b3338a6 is described below
commit f2dd0b3338a6937bbfbea6cd5fffb2bf9992a1f3
Author: Wei Guo <gu...@gmail.com>
AuthorDate: Wed Jul 10 16:37:45 2024 +0900
[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: https://github.com/sphinx-doc/sphinx/issues/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:

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 <gu...@gmail.com>
Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
dev/requirements.txt | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/dev/requirements.txt b/dev/requirements.txt
index c9d07fae000b..e0216a63ba79 100644
--- a/dev/requirements.txt
+++ b/dev/requirements.txt
@@ -37,6 +37,13 @@ nbsphinx
numpydoc
jinja2
sphinx==4.5.0
+# With sphinx 4.5.0, we need to set the upperbound version of sphinxcontrib*, it should be removed after upgrading sphinx>=5
+sphinxcontrib-applehelp<=1.0.4
+sphinxcontrib-devhelp<=1.0.2
+sphinxcontrib-htmlhelp<=2.0.1
+sphinxcontrib-jsmath<=1.0.1
+sphinxcontrib-qthelp<=1.0.3
+sphinxcontrib-serializinghtml<=1.1.5
sphinx-plotly-directive
sphinx-copybutton
docutils<0.18.0
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org