[issue15605] Explain sphinx documentation building in devguide

Chris Jerdonek report at bugs.python.org
Thu Aug 9 20:56:20 CEST 2012


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<builder> . build/<outputdirectory>

Note that the build instructions for the Developer's Guide live at a separate location at the bottom of this page:

http://docs.python.org/devguide/docquality.html#helping-with-the-developer-s-guide

Also, IIRC the build directory for the Developer's Guide is "_build" rather than "build" as it is for the main Python documentation.

Lastly, a couple nits: "Developer's Guide" should be capitalized and "can not" should be one word.

----------
nosy: +cjerdonek

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15605>
_______________________________________


More information about the Python-bugs-list mailing list