Basic Installation

---

Prerequisites

The Sphinx ecosystem, if not already installed.

Tip

recommended location: create docs folder at your project directory and install sphinx there.

mkdir docs

Start installation with:

sphinx install

sphinx-quickstart

At path docs run

build documentation

    make html

This will build the folder, file structure at /docs/build folder, e.g. /docs/build/html/index.html. Run index.html in brower to see if the installation was successful.

You could remove the build with

build documentation

    make clean

Tip

Keep the commands make clean and make html in mind, you’ll use them frequently.