[issue15605] Explain sphinx documentation building in devguide

Éric Araujo added the comment: Updated text is clear and comprehensive, thanks! Another edit could be done after the packaging docs is revamped to add links to the pyvenv and pip sections of the doc, to avoid users reading “install Sphinx and its deps” and not knowing how to do that.

[issue15605] Explain sphinx documentation building in devguide

Georg Brandl added the comment: Thanks for your patience. I believe I have addressed all issues raised. -- nosy: +georg.brandl ___ Python tracker ___

[issue15605] Explain sphinx documentation building in devguide

Roundup Robot added the comment: New changeset f32569ddc2db by Georg Brandl in branch 'default': Closes #15605: update and refurbish doc building section of the devguide. http://hg.python.org/devguide/rev/f32569ddc2db -- nosy: +python-dev resolution: -> fixed stage: -> committed/reject

[issue15605] Explain sphinx documentation building in devguide

Éric Araujo added the comment: Note that 3.4 finally removes getting Sphinx from a subversion repository, so the installation instructions will need a version-specific part for that. -- ___ Python tracker

[issue15605] Explain sphinx documentation building in devguide

Zachary Ware added the comment: In issue17386, I have offered a patch to Doc/make.bat which makes using make.bat on Windows very, very nearly the same as using make on UNIX. With such a patch applied, it would be trivial to rewrite section 7.6.1 with instructions that apply equally well to bo

[issue15605] Explain sphinx documentation building in devguide

Terry J. Reedy added the comment: >"Python 2" should be enough. I thought about that. Agreed. "make -C Doc xxx" will not work with make.bat. Perhaps "7.6.1. Using make" should be expanded to "7.6.1 Using make on unix" and "7.6.2 Using make on Windows" added. Then the directory assumption could

[issue15605] Explain sphinx documentation building in devguide

Ezio Melotti added the comment: > change '2.4 or higher' to '2.4 to 2.7'. "Python 2" should be enough. > Perhaps we should add "These instructions assume that /Doc/ > is the current directory." Then we would not have to repeat in multiple > places. There was a somewhat related discussion abou

[issue15605] Explain sphinx documentation building in devguide

Terry J. Reedy added the comment: I initially had a bit of the same confusion as Daniel, and hence agree on clarifying. I have more comments on 7.6. Building the documentation. 1. "You need to have Python 2.4 or higher installed." Until 3.x docs can be built with 3.x, (and I just verified tha

[issue15605] Explain sphinx documentation building in devguide

Changes by Tshepang Lekhonkhobe : -- nosy: +tshepang ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mai

[issue15605] Explain sphinx documentation building in devguide

Chris Jerdonek added the comment: +If you are building the developer's guide, or for some other reason can not use +the `tools/sphinx-build.py` file, you can also run the following command from +the directory containing `conf.py` :: + + sphinx-build -b . build/ Note that the build instructions

[issue15605] Explain sphinx documentation building in devguide

Daniel Ellis added the comment: That makes sense. I've added a brief explanation noting that the user should be in the "Docs" directory to run the command. When trying to update the dev guide, I noticed that this same "tools" directory does not exist in the repo, so I also added instructions

[issue15605] Explain sphinx documentation building in devguide

R. David Murray added the comment: It refers to the 'tools' subdirectory in the Doc directory, but that doesn't exist unless you've built the docs with 'make' before, or done a 'make checkout'. Presumably you have sphinx installed on your system separately, and that's why you were able to run

[issue15605] Explain sphinx documentation building in devguide

New submission from Daniel Ellis: At the bottom of this page: http://docs.python.org/devguide/documenting.html There is a command explaining how to build the documentation without using make: python tools/sphinx-build.py -b . build/ It is unclear as to which directory the "tools" is referr