What is Sphinx?
Sphinx is a documenter for programmers that is capable of putting out TXT, TexInfo, HTML, ePub and LaTeX documentation. While the program was initially developed for use by programmers using the Python language, it has since been developed to serve the needs of C and C++ programmers as well. Indeed, development is continuing to expand the list of languages that the program supports.
Sphinx requires several things if it is to operate properly: one of these is Python 2.5/3.1. Another is the docutils library. The latter is due to the fact that the program’s markup language is reStructuredText. The Jinja2 library is another requirement for Sphinx users, as is the Pygments library (although Pygments is really only needed if the user wants to enable highlighting for his source code).
Sphinx is capable of performing automated indexing (general and module-specific). It can also test code snippets automatically, although this particular feature requires a specific plugin of the program to be installed first. The program lets users create document trees using a hierarchical structure that is built with automated linking. Finally, the program also allows users to perform as much cross-referencing as they want for their documentation.
Looking for cool wallpapers?