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:

pip install sphinx_rtd_theme

Sphinx on Windows

Install Software:

  1. Python 3.7.0.
  2. MikTex for PDF generation.
  3. Make for Windows for PDF generation.

Check application versions:

python --version
make --version

Make and python shall be in the PATH.

Creating Project File Tree

To get started with actual documentation project open Terminal, change current working directory to document project root and execute command:

sphinx-quickstart