sphinx-build

Sphinx documentation generator. More information: <http://www.sphinx-doc.org/en/master/man/sphinx-build.html>.

Install

All systems
curl cmd.cat/sphinx-build.sh
Debian Debian
apt-get install python-sphinx
Ubuntu
apt-get install python-sphinx
Arch Arch Linux
pacman -S python-sphinx
image/svg+xml Kali Linux
apt-get install python-sphinx
CentOS
yum install python-sphinx
Fedora
dnf install python2-sphinx-1
Windows (WSL2)
sudo apt-get update sudo apt-get install python-sphinx
Raspbian
apt-get install python-sphinx
Dockerfile
dockerfile.run/sphinx-build

Sphinx documentation generator. More information: <http://www.sphinx-doc.org/en/master/man/sphinx-build.html>.

  • Build documentation:
    sphinx-build -b html|epub|text|latex|man|... path/to/source_dir path/to/build_dir
  • Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package):
    sphinx-build -b html path/to/docs_dir path/to/build_dir

© tl;dr; authors and contributors