Sphinx

Sphinx Installation

Applies to: Ubuntu 16.04 LTS. Installation on Ubuntu Ubuntu already has python3 installed and it is supported by Sphinx. Installation is simple: sudo apt-get install python3-sphinx That’s it for installation. Installation with PIP on any platform For existing projects you can restore python dependencies with a single command: pip install -r requirements.txt If starting from scratch, install the following python packages manually. Command: pip install -U sphinx Install Theme unless custom theme is desired:

Sphinx Development Environment

Building Documentation Commands: make html make latexpdf Troubleshooting no module named doc8 Command: pip install doc8 Note Run as normal user.

Sphinx References

reStructuredText Primer HTML theming support LaTeX Builder