Sphinx Doc

Sphinx Doc ist ein Statischer Website Generator für Dokumentationen. Sphinx Doc erstellt aus ReStructuredText-Dateien eine HTML-Datei.

Sphinx Doc installieren bei Ubuntu

Installieren Sie Sphinx Doc mit folgendem Befehl.

sudo apt-get install python3 python3-pip python3-venv

Venv erstellen thorsten

python3 -m venv thorsten // erstellt ein venv mit dem Namen thorsten
source thorsten/bin/activate // aktiviert das venv

Sphinx Doc installieren

Installieren Sie Sphinx Doc mit folgendem Befehl.

pip3 install sphinx

Sphinx Doc Erstellen

Erstellen Sie ein neues Projekt mit folgendem Befehl.

sphinx-quickstart Projectname

Sphinx Doc starten

Starten Sie Sphinx Doc mit folgendem Befehl.

make html