Daniel Arbuckle's Mastering Python

Sphinx

Sphinx is a tool that can process Python source code and standalone documentation files and generate nicely formatted documentation in a number of formats, notably HTML. Sphinx, like other Python documentation tools, recognizes a markup language called reStructuredText, which is intentionally readable and informative, even when its markup is presented as plaintext rather than being interpreted.

reStructuredText can be found at the following link: https://docs.python.org/devguide/documenting.html#reStructuredText-primer.

reStructuredText documents are still readable in a simple text editor, but when we feed them through a tool such as Sphinx they make the end result richer. The reStructuredText syntax is based on the conventions that ...