This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: make html fails on OSX
Type: Stage: resolved
Components: Build Versions: Python 3.6
process
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: Nosy List: Alex.LordThorsen, cheryl.sabella, martin.panter
Priority: normal Keywords:

Created on 2016-02-28 02:31 by Alex.LordThorsen, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (7)
msg260954 - (view) Author: Alex LordThorsen (Alex.LordThorsen) * Date: 2016-02-28 02:31
Did a fresh hg clone of the python 3.6 code base (3.6.0a0) on  OSX 10.10.5 and made a modification to a library rst. I went to build my changes and ran

$ make html
sphinx-build -b html -d build/doctrees -D latex_paper_size=  . build/html
make: sphinx-build: No such file or directory
make: *** [build] Error 1

I looked at https://docs.python.org/devguide/documenting.html#building-doc to see about what I can do about this failure and didn't see anything OSX specific. 

$ sphinx-build -b html . build/html

Works, however.
msg260955 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-02-28 02:50
I suspect this is not OS X specific. The documentation that you linked says “Sphinx is maintained separately and is not included in this tree.”

By your output I suspect you need to install the sphinx-build program. On Arch Linux I had to install it myself:

$ pacman -Qo sphinx-build
/usr/bin/sphinx-build is owned by python-sphinx 1.3.4-1
$ pacman -Qi python-sphinx
Name           : python-sphinx
Version        : 1.3.4-1
Description    : Python3 documentation generator
Architecture   : any
URL            : http://sphinx.pocoo.org/
msg260956 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-02-28 02:52
Sorry I didn’t read the last bit of your message where you run sphinx-build manually. So I take back my last comment :)
msg260957 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-02-28 02:58
The only thing I can think of is checking the PATH environment variable. What is it inside the Makefile, and what is it when you run the command manually?
msg260958 - (view) Author: Alex LordThorsen (Alex.LordThorsen) * Date: 2016-02-28 03:05
So I think this is really a documentation bug after playing with this a little bit. I built a virtual env and pip installed sphinx. If I'm in the virtual environment the build succeeds and out of it fails.

The documentation states that you need sphinx (in a different section) but doesn't have a step that explicitly tells you to install it.

Do devguide issues go on this bug tracker?
msg260959 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-02-28 03:13
Yeah if you want to propose a specific change for the devguide, or even a patch, go right ahead :)
msg313832 - (view) Author: Cheryl Sabella (cheryl.sabella) * (Python committer) Date: 2018-03-14 18:10
With the new instructions for building the docs via `make venv` and then `make html`, I believe this issue can be closed.
History
Date User Action Args
2022-04-11 14:58:28adminsetgithub: 70637
2018-03-14 18:10:03cheryl.sabellasetstatus: open -> closed

nosy: + cheryl.sabella
messages: + msg313832

resolution: not a bug -> out of date
stage: resolved
2016-02-28 03:13:04martin.pantersetmessages: + msg260959
2016-02-28 03:05:49Alex.LordThorsensetmessages: + msg260958
2016-02-28 02:58:54martin.pantersetmessages: + msg260957
2016-02-28 02:52:26martin.pantersetstatus: closed -> open

messages: + msg260956
2016-02-28 02:50:46martin.pantersetstatus: open -> closed

nosy: + martin.panter
messages: + msg260955

resolution: not a bug
2016-02-28 02:31:06Alex.LordThorsencreate