This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch branch-3.0
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-3.0 by this push:
new 3bb74c0 [SPARK-34442][INFRA][DOCS][3.0] Pin Sphinx version to
`sphinx<3.5.0`
3bb74c0 is described below
commit 3bb74c07ab23c589d3caf6f352fc13600fd68b03
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Mon Feb 15 14:59:28 2021 -0800
[SPARK-34442][INFRA][DOCS][3.0] Pin Sphinx version to `sphinx<3.5.0`
### What changes were proposed in this pull request?
This PR aims to pin the Sphinx version to avoid 3.5.0 changes. Note that
Spark 3.1.0+ switches the document structure and it has a stronger restriction
than this. This PR is irrelevant to SPARK-32407.
```
SPARK-32407: Sphinx 3.1+ does not correctly index nested classes.
```
### Why are the changes needed?
[Sphinx 3.5.0](https://pypi.org/project/Sphinx/3.5.0/) was released Feb.
13rd, 2021 and broke GitHub Action Python Linter job.
- https://github.com/apache/spark/runs/1906315781
- https://github.com/apache/spark/runs/1906310012
```
Extension error (sphinx.ext.viewcode):
Handler <function env_purge_doc at 0x7f1d9a6420d0> for event
'env-purge-doc' threw an exception (exception: 'bool' object is not iterable)
make: *** [Makefile:55: html] Error 2
```
**THIS PR**
- https://github.com/apache/spark/pull/31568/checks?check_run_id=1906638805
```
starting python compilation test...
python compilation succeeded.
starting pycodestyle test...
pycodestyle checks passed.
starting flake8 test...
flake8 checks passed.
starting sphinx-build tests...
sphinx-build checks passed.
all lint-python tests passed!
```
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Pass the GitHub Action CI.
Closes #31568 from dongjoon-hyun/SPHINX.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
.github/workflows/build_and_test.yml | 2 +-
docs/README.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/build_and_test.yml
b/.github/workflows/build_and_test.yml
index d1c404e..355ecfc 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -322,7 +322,7 @@ jobs:
- name: Install dependencies for documentation generation
run: |
apt-get install -y libcurl4-openssl-dev pandoc
- python3.6 -m pip install sphinx mkdocs numpy
+ python3.6 -m pip install "sphinx<3.5.0" mkdocs numpy
apt-get update -y
apt-get install -y ruby ruby-dev
gem install jekyll jekyll-redirect-from rouge
diff --git a/docs/README.md b/docs/README.md
index a1c569e..984ef8e 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -64,7 +64,7 @@ Note: Other versions of roxygen2 might work in SparkR
documentation generation b
To generate API docs for any language, you'll need to install these libraries:
```sh
-$ sudo pip install sphinx mkdocs numpy
+$ sudo pip install 'sphinx<3.5.0' mkdocs numpy
```
## Generating the Documentation HTML
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
