Tworzenie dokumentacji

Ten dokument wyjaśnia, jak zbudować dokumentację Sphinx dla aplikacji Parrot. Omówimy konfigurację środowiska wirtualnego (venv), instalację pip i korzystanie z pliku

Informacja

Parrot jest w wczesnym etapie rozwoju i nie jest jeszcze gotowy dla użytkowników końcowych.

Instrukcje instalacji

Klonuj repozytorium: Najpierw sklonuj repozytorium używając tego polecenia:
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
Zmień katalog na repozytorium: Po klonowaniu, przejdź do katalogu głównego projektu, uruchamiając:
```
cd parrot-wtf
```

Zainstaluj python3-venv (apt): Jest to wymagane do tworzenia środowiska wirtualnego. Uruchom ten polecenie:

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

Konfigurowanie wirtualnego środowiska (venv): Przejdź do katalogu głównego swojego projektu i uruchom:
```
python3 -m venv venv
```
Aktywuj wirtualne środowisko: Przed instalacją pakietów aktywuj wirtualne środowisko, uruchamiając:
```
source venv/bin/activate
```
Używaj requirements.txt: Ten plik zawiera listę zależności projektu. Aby je zainstalować przy użyciu pip, uruchom:
```
pip install -r requirements.txt
```

Zainstaluj podmoduły: Zainstaluj inne podmoduły repozytorium Parrot, aby uwzględnić ich dokumentację.

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

Budowanie dokumentacji

Wyczyść istniejącą kompilację: Jeśli wcześniej skompilowałeś dokumentację, zacznij od wyczyszczenia starych plików kompilacji za pomocą tego polecenia:
```
make clean
```
Skompiluj wersję HTML dokumentacji: Aplikacja Parrot wykorzystuje Sphinx do generowania dokumentacji. Aby utworzyć wersję HTML, uruchom:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Wypchnij na serwer WWW

Po skompilowaniu dokumentacji znajdziesz pliki HTML w katalogu build/html. Są to pliki, które muszą zostać przesłane na Twój serwer www.

Edytuj .env aby ustawić adres serwera używany przez rsync, np.:

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

Wykonaj następujące polecenie, aby rsync na serwer:

./scripts/rsync-parrot-wtf

Ten wypchnie wszystkie pliki HTML w build/html na Twój główny serwer.

Informacja

Dokumentacja Parrot jest opisana w języku angielskim i korzysta z tłumaczenia maszynowego opartego na sztucznej inteligencji dla innych języków.