Github user viirya commented on a diff in the pull request:
https://github.com/apache/spark/pull/21659#discussion_r199053321
--- Diff: python/docs/Makefile ---
@@ -1,19 +1,36 @@
# Makefile for Sphinx documentation
#
+# You can set this variable from command line to force Sphinx to use the
Python executable.
+SPHINXPYTHON ?= python
+
+ifndef SPHINXBUILD
+# Note that there is an issue with Python version and Sphinx in PySpark
documentation generation.
+# Please remove this check below when this issue is fixed. See SPARK-24530
for more details.
+PYTHON_VERSION_CHECK = $(shell $(SPHINXPYTHON) -c 'import sys;
print(sys.version_info < (3, 0, 0))')
+ifeq ($(PYTHON_VERSION_CHECK), True)
+$(warning Note that Python 3 is required to generate PySpark documentation
correctly for now. Current Python executable was less than Python 3. See
SPARK-24530. To force Sphinx to use a specific Python executable, please set
SPHINXPYTHON to point to the Python 3 executable.)
+endif
+# Check if Sphinx is installed.
+ifeq ($(shell $(SPHINXPYTHON) -c 'import sphinx' >/dev/null 2>&1; echo
$$?), 1)
+$(error Python executable '$(SPHINXPYTHON)' did not have Sphinx installed.
Make sure you have Sphinx installed, then set the SPHINXPYTHON environment
variable to point to the Python executable having Sphinx installed. If you
don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+else
+# User-friendly check for sphinx-build if explicitly specified.
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have
Sphinx installed, then set the SPHINXBUILD environment variable to point to the
full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the
directory with the executable to your PATH. If you don't have Sphinx installed,
grab it from http://sphinx-doc.org/)
+endif
+endif
+
# You can set these variables from the command line.
SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
+# Use 'SPHINXPYTHON -msphinx' instead of 'sphinx-build' by default. See
https://github.com/sphinx-doc/sphinx/pull/3523 for more details.
+SPHINXBUILD ?= $(SPHINXPYTHON) -msphinx
--- End diff --
Put in `SPHINXOPTS`?
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
