[spark] branch branch-3.3 updated: [SPARK-38780][PYTHON][DOCS] PySpark docs build should fail when there is warning

[gu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch branch-3.3
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-3.3 by this push:
     new ea8adb9722d [SPARK-38780][PYTHON][DOCS] PySpark docs build should fail when there is warning
ea8adb9722d is described below

commit ea8adb9722d22bea170877a41af8108b884bee07
Author: itholic <ha...@databricks.com>
AuthorDate: Mon Apr 4 15:19:46 2022 +0900

    [SPARK-38780][PYTHON][DOCS] PySpark docs build should fail when there is warning
    
    ### What changes were proposed in this pull request?
    
    This PR proposes to add option "-W" when running PySpark documentation build via Sphinx.
    
    ### Why are the changes needed?
    
    To make documentation build failing when the documentation violates the Sphinx warning rules.
    
    So far, the docs build is passed although the docs has warnings as below:
    ```
    …
    build succeeded, 14 warnings.
    ```
    
    With this change, the warnings treated as error, so the build should be failed as below for an example:
    ```
    Warning, treated as error:
    …:153:Malformed table.
    Text in column margin in table line 38.
    …
    make: *** [html] Error 2
    ```
    
    ### Does this PR introduce _any_ user-facing change?
    
    This would make docs a bit more prettier.
    
    ### How was this patch tested?
    
    The existing build & tests should be passed.
    
    Closes #36058 from itholic/SPARK-38780.
    
    Authored-by: itholic <ha...@databricks.com>
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
    (cherry picked from commit bd8100b78e7f357725bfa54697a27a0c421ef496)
    Signed-off-by: Hyukjin Kwon <gu...@apache.org>
---
 python/docs/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/python/docs/Makefile b/python/docs/Makefile
index 14e5214fc1e..65ab6cfa3ec 100644
--- a/python/docs/Makefile
+++ b/python/docs/Makefile
@@ -16,7 +16,7 @@
 # Minimal makefile for Sphinx documentation
 
 # You can set these variables from the command line.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= "-W"
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     ?= source
 BUILDDIR      ?= build


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