From bb9df2a18a98a0e91a4ff168b7a8e1bea1ec6839 Mon Sep 17 00:00:00 2001 From: Chandan Singh Date: Sat, 29 Dec 2018 01:25:59 +0000 Subject: doc/Makefile: Update comment about sphinx entrypoint https://github.com/sphinx-doc/sphinx/issues/4375 has been closed as `wontfix`. Update the comment in doc/Makefile that mentions it, based on the discussion on the issue. --- doc/Makefile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index f52b869ef..7bc3cb363 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,10 +6,10 @@ # we dont use the standard `sphinx-build` and `sphinx-apidoc` entry points. # # The following technique works as long as sphinx is installed for python3, -# regardless of the entry point which might be in /usr/bin or PATH, but -# will stop working in sphinx >= 2.0. Hopefully by then, the mentioned -# bug will be fixed and we can use a standard python3 specific script to -# invoke sphnix. +# regardless of the entry point which might be in /usr/bin or PATH. +# +# Since Sphinx 2.0 is planned to be Python 3-only, this workaround should not +# be needed once Spinx 2.0 is released, and we upgrade to it # SPHINXOPTS = SPHINXBUILD = python3 -m sphinx -- cgit v1.2.1