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 180fae8  [SPARK-35425][BUILD][3.0] Pin jinja2 in spark-rm/Dockerfile 
and add as a required dependency in the release README.md
180fae8 is described below

commit 180fae86fb9e116706f0e6c94e1e179d5bdd8147
Author: Kousuke Saruta <saru...@oss.nttdata.com>
AuthorDate: Tue May 18 09:39:02 2021 -0700

    [SPARK-35425][BUILD][3.0] Pin jinja2 in spark-rm/Dockerfile and add as a 
required dependency in the release README.md
    
    ### What changes were proposed in this pull request?
    
    This PR backports SPARK-35425 (#32573).
    
    The following two things are done in this PR.
    
    * Add note about Jinja2 as a required dependency for document build.
    * Add Jinja2 dependency for the document build to `spark-rm/Dockerfile`
    
    ### Why are the changes needed?
    
    SPARK-35375(#32509) confined the version of Jinja to <3.0.0.
    So it's good to note about it in `docs/README.md` and add the dependency to 
`spark-rm/Dockerfile`.
    
    ### Does this PR introduce _any_ user-facing change?
    
    No.
    
    ### How was this patch tested?
    
    I confimed that `make html` succeed under `python/docs` with dependencies 
installed by both of the following commands.
    ```
    pip install sphinx==2.3.1 mkdocs==1.0.4 numpy==1.18.1 jinja2==2.11.3
    pip install 'sphinx<3.5.0' mkdocs numpy 'jinja2<3.0.0'
    ```
    
    Closes #32579 from sarutak/backport-SPARK-35425-branch-3.0.
    
    Authored-by: Kousuke Saruta <saru...@oss.nttdata.com>
    Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
 dev/create-release/spark-rm/Dockerfile | 4 +++-
 docs/README.md                         | 7 ++++++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/dev/create-release/spark-rm/Dockerfile 
b/dev/create-release/spark-rm/Dockerfile
index ff6af6f..2fad573 100644
--- a/dev/create-release/spark-rm/Dockerfile
+++ b/dev/create-release/spark-rm/Dockerfile
@@ -33,7 +33,9 @@ ENV DEBCONF_NONINTERACTIVE_SEEN true
 # These arguments are just for reuse and not really meant to be customized.
 ARG APT_INSTALL="apt-get install --no-install-recommends -y"
 
-ARG PIP_PKGS="sphinx==2.3.1 mkdocs==1.0.4 numpy==1.18.1"
+# TODO(SPARK-35375): Jinja2 3.0.0+ causes error when building with Sphinx.
+#   See also https://issues.apache.org/jira/browse/SPARK-35375.
+ARG PIP_PKGS="sphinx==2.3.1 mkdocs==1.0.4 numpy==1.18.1 jinja2==2.11.3"
 ARG GEM_PKGS="jekyll:4.0.0 jekyll-redirect-from:0.16.0 rouge:3.15.0"
 
 # Install extra needed repos and refresh.
diff --git a/docs/README.md b/docs/README.md
index 984ef8e..1d31fd1 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -63,8 +63,13 @@ 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:
 
+<!--
+TODO(SPARK-35375): Jinja2 3.0.0+ causes error when building with Sphinx.
+See also https://issues.apache.org/jira/browse/SPARK-35375.
+-->
+
 ```sh
-$ sudo pip install 'sphinx<3.5.0' mkdocs numpy
+$ sudo pip install 'sphinx<3.5.0' mkdocs numpy 'jinja2<3.0.0'
 ```
 
 ## Generating the Documentation HTML

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org

Reply via email to