Sphinx¶

Sphinx makes it easy to create intelligent and beautiful documentation.

Requirements (sphinx)¶

~ $ command -v sphinx-build
$LOCAL/bin/sphinx-build
~ $ $LOCAL/bin/sphinx-build --version
sphinx-build ...

If the output is empty, then you need to install Sphinx

~ $ pip install sphinx --user
Successfully installed sphinx-...

Alternatively, See the official documentation Installing Sphinx

Note

The ‘–user’ option is specified to install into

$HOME/.local/lib/pythonXX/site-packages

and the entry point into

$HOME/.local/bin