Sphinx is a documentation generation tool. It began as a way to produce Python documentation, but it is branching out to other languages, notably C/C++. It can produce output in several formats, including HTML, LaTeX, ePub, man pages, and plain text, among others. It accepts reStructuredText and builds upon the Docutils suite, adding a few pieces of markup along the way.
Sphinx can be installed using pip:
pip install sphinx
Installation will add several scripts to the path. The first one we will examine is named sphinx-quickstart. It will set up a prompt the user for information and then a source directory, a configuration file, and some skeleton files:
bash-4.1$ sphinx-quickstart Welcome to the Sphinx 1.3.6 quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets). Enter the root path for documentation. > Root path for the documentation [.]: docs You have two options for...