From: Angus Gratton <angus@espressif.com>
Date: Wed, 29 Aug 2018 04:00:41 +0000 (+0800)
Subject: docs: Call 'python -m sphinx' instead of sphinx-build
X-Git-Tag: v3.2-beta1~257^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1abd3469433792583f7057e71e5068b1881d616b;p=esp-idf

docs: Call 'python -m sphinx' instead of sphinx-build

Fixes mismatches where default Python interpreter may not match the most recently
installed sphinx-build wrapper script (if sphinx 2 & 3 both installed, pip will
clobber any previous copy of /bin/sphinx-build when it installs the new one.)
---

diff --git a/docs/docs_common.mk b/docs/docs_common.mk
index 85056dc394..c79cb0d4b6 100644
--- a/docs/docs_common.mk
+++ b/docs/docs_common.mk
@@ -15,15 +15,12 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+# note: this is changed from sphinx-build so it depends on default python interpreter, not on /bin/sphinx-build
+# (which will be the most recently installed version of sphinx and may not match)
+SPHINXBUILD   = python2 -m sphinx
 PAPER         =
 BUILDDIR      = _build
 
-# User-friendly check for sphinx-build
-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
-
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter