diff options
| author | Chandan Singh <csingh43@bloomberg.net> | 2018-12-29 01:25:59 +0000 |
|---|---|---|
| committer | Chandan Singh <chandan@chandansingh.net> | 2019-01-02 11:59:35 +0000 |
| commit | bb9df2a18a98a0e91a4ff168b7a8e1bea1ec6839 (patch) | |
| tree | 31226519b7cef0c3cc10701eb0812d285fbdbc37 | |
| parent | b848172c518d3d52a94feded9e12a0b69a27f1d7 (diff) | |
| download | buildstream-chandan/update-doc-makefile-note.tar.gz | |
doc/Makefile: Update comment about sphinx entrypointchandan/update-doc-makefile-note
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.
| -rw-r--r-- | doc/Makefile | 8 |
1 files 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 |