Using Sphinx to produce the documentation
The Sphinx tool produces very good-looking documentation in a variety of formats. It can easily combine documentation from source code as well as external files with additional design notes, requirements, or background.
The Sphinx tool can be found at http://sphinx-doc.org. The download can become complex because Sphinx depends on several other projects. It may be easier to first install setuptools
, which includes the easy_install
script, and then use this to install Sphinx. This can help us with the details of tracking down the additional projects that must be installed first.
See https://pypi.python.org/pypi/setuptools for help on setuptools
.
Some developers prefer to use pip
for this kind of installation. ...
Get Mastering Object-oriented Python now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.