Expert Python Programming - Third Edition

Sphinx

Sphinx (http://sphinx.pocoo.org) is a set of scripts and docutils extensions that can be used to generate an HTML structure from the tree of plain text documents that are created using the reStructuredText syntax language (you can find more details on that markup language in Appendix A, reStructuredText Primer). Sphinx also supports multiple other documentation output formats, like man pages, PDF, or even LaTex. This tool is used (for instance) to build official Python documentation and is very popular among many open source Python projects. It provides a really nice browsing system, together with a light but sufficient client-side JavaScript search engine. It also uses pygments for rendering code examples, which produces really nice ...