Erstellen der Dokumentation

Dieses Dokument erklärt, wie man die Sphinx-Dokumentation für die Parrot-Anwendung aufbaut. Wir werden dabei das Einrichten einer virtuellen Umgebung (venv), die Installation von pip und die

Bemerkung

Parrot ist in früher Entwicklung und nicht für Endbenutzer bereit.

Einrichtungsanweisungen

1. Repository klonen: Zuerst klonen Sie das Repository mit diesem Befehl:

   git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
   

2. In das Repository-Verzeichnis wechseln: Nachdem Sie ein Klonen durchgeführt haben, navigieren Sie zum Stammverzeichnis des Projekts, indem Sie den folgenden Befehl ausführen:

   cd parrot-wtf
   

3. Installiere python3-venv (apt): Das ist erforderlich, um eine virtuelle Umgebung zu erstellen. Führe diesen Befehl aus:

   sudo apt update
   sudo apt install docutils gettext python3-pip python3-venv
   # To build PDFs with LaTeX
   sudo apt install texlive-full xindy
   

4. Richten Sie eine virtuelle Umgebung (venv) ein: Navigieren Sie zum Stammverzeichnis Ihres Projekts und führen Sie aus:

   python3 -m venv venv
   

5. Aktiviere die virtuelle Umgebung: Bevor du irgendwelche Pakete installierst, aktiviere die virtuelle Umgebung, indem du ausführst:

   source venv/bin/activate
   

6. Benutzen Sie requirements.txt: Diese Datei enthält eine Liste von Projekt-Abhängigkeiten. Um sie mit pip zu installieren, führen Sie aus:

   pip install -r requirements.txt
   

7. Submodule installieren: Installieren Sie weitere Submodule des Parrot-Repositorys, um deren Dokumentation einzubinden.

   pip install -r datasets/requirements.txt
   pip install -r extension/requirements.txt
   pip install -r ide/requirements.txt
   pip install -r models/requirements.txt
   
   pip install -e datasets
   

Erstellen der Dokumentation

1. Bestehende Erstellen bereinigen: Wenn Sie die Dokumentation bereits erstellt haben, beginnen Sie mit der Bereinigung der alten Build-Dateien mit diesem Befehl:

   make clean
   

2. Erstellen Sie die HTML-Version der Dokumente: Die Parrot-Anwendung verwendet Sphinx, um ihre Dokumentation zu erstellen. Um die HTML-Version zu erstellen, führen Sie aus:

   make html
   

3. Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:

   make help
   

Push to Web Server

Nach dem Aufbau der Dokumentation finden Sie die HTML-Dateien im Verzeichnis build/html. Das sind die Dateien, die auf Ihren Webserver hochgeladen werden müssen.

Bearbeite .env, um die Server-URL für rsync festzulegen, z.B.:

URL="parrot.wtf:/var/www/html/parrot-wtf/"

Führen Sie den folgenden Befehl aus, um mit rsync auf den Server zu übertragen:

./scripts/rsync-parrot-wtf

Das wird alle HTML-Dateien im build/html an Ihren Hauptserver übertragen.

Bemerkung

Die Parrot-Dokumentation ist auf Englisch verfasst und verwendet künstliche Intelligenz für die Übersetzung in andere Sprachen.