Bouw documentatie

Dit document legt uit hoe u de Sphinx-documentatie voor de Parrot-toepassing bouwt. We zullen bespreken het instellen van een virtuele omgeving (venv), het installeren van

Notitie

Parrot bevindt zich in de vroege ontwikkelingsfase en is nog niet klaar voor eindgebruikers.

Installatie-instructies

Kloon de repository: Eerst kloon de repository met deze opdracht:

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

Ga naar de map van het archief: Na het klonen, navigeer naar de hoofdmap van het project door uit te voeren:
```
cd parrot-wtf
```

Installeer python3-venv (apt): Dit is vereist voor het maken van een virtuele omgeving. Voer deze opdracht uit:

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

Stel een virtuele omgeving (venv) in: Ga naar de hoofdmap van uw project en voer uit:
```
python3 -m venv venv
```
Activeer de virtuele omgeving: Voordat u pakketten installeert, activeert u de virtuele omgeving door uit te voeren:
```
source venv/bin/activate
```
Use requirements.txt: This file contains a list of project dependencies. To install them using pip, run:
```
pip install -r requirements.txt
```

Installeer Submodules: Installeer andere Parrot-opslagplaatssubmodules om hun documentatie op te nemen.

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

Bouwen van de documentatie

Schoonmaken bestaande bouw: Als u de documentatie eerder hebt gebouwd, begint u met het opschonen van de oude bouwbestanden met deze opdracht:
```
make clean
```
Bouw de HTML-versie van de documentatie: De Parrot-toepassing maakt gebruik van Sphinx om zijn documentatie te genereren. Om de HTML-versie te maken, voer je het volgende uit:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Verzend naar webserver

Na het bouwen van de documentatie vindt u de HTML-bestanden in de map build/html. Dit zijn de bestanden die moeten worden geüpload naar uw webserver.

Bewerk .env om de server-URL in te stellen die door rsync wordt gebruikt, bijvoorbeeld:

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

Voer de volgende opdracht uit om te rsync naar de server:

./scripts/rsync-parrot-wtf

Dit zal alle HTML-bestanden in build/html naar uw hoofdserver pushen.

Notitie

De documentatie van Parrot wordt in het Engels geschreven en maakt gebruik van AI-machinetranslatie voor andere talen.