Bygg dokumentation

Detta dokument förklarar hur man skapar Sphinx-dokumentationen för Parrot-programmet. Vi kommer att täcka upprättandet av en virtuell miljö (venv), installera pip

Observera

Parroten är under tidig utveckling och är inte redo för slutanvändare.

Installationsanvisningar

Klona databasen: Klona först databasen med detta kommando:

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

Byt katalog till databasen: Efter kloning, navigera till projektets rotkatalog genom att köra:
```
cd parrot-wtf
```

Installera python3-venv (apt): Detta krävs för att skapa en virtuell miljö. Kör detta kommando:

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

Ställ in en virtuell miljö (venv): Gå till projektets rotkatalog och kör:
```
python3 -m venv venv
```
Aktivera den virtuella miljön: Innan du installerar några paket aktiverar du den virtuella miljön genom att köra:
```
source venv/bin/activate
```
Använd requirements.txt: Denna fil innehåller en lista över projektets beroenden. För att installera dem med pip, kör:
```
pip install -r requirements.txt
```

Installera delmoduler: Installera andra Parrot-databasens delmoduler för att inkludera deras dokumentation.

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

Bygga dokumentationen

Rensa befintlig version: Om du tidigare har byggt dokumentationen börjar du med att rensa de gamla byggfilerna med detta kommando:
```
make clean
```
Bygg den HTML-versionen av dokumentationen: Parrot-programmet använder Sphinx för att generera sin dokumentation. För att skapa HTML-versionen, kör:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Skicka till webbservern

Efter att ha byggt dokumentationen hittar du HTML-filerna i katalogen build/html. Det är dessa filer som behöver laddas upp till din webbserver.

Redigera .env för att ange serverns URL som ska användas av rsync, till exempel:

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

Kör följande kommando för att rsync till servern:

./scripts/rsync-parrot-wtf

Detta kommer att skicka alla HTML-filer i bygg/html till din huvudserver.

Observera

Parrot-dokumentationen är skriven på engelska och använder AI-maskinöversättning för andra språk.