O'Reilly logo

Mastering Object-oriented Python by Steven Lott

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

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. ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required