Konstrui Dokumentaron

Tiu ĉi dokumento priskribas kiel konstrui la Sphinx-an dokumentaron por la Parrot-aplikaĵo. Ni vidigos agordi virtuan ekzemploenon (venv), inst

Note

Parroto estas en la timiga komenco, ne preta por finaj uzantoj.

Agordaj instrukcioj

Klonu la deponejo: Unue, klonu la deponejon per tiu komando:

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

Aliru al deponejo: Post klonado, iru al la radikodirektoro de la projekto per rulante:
```
cd parrot-wtf
```

Instali python3-venv (apt): Tio estas bezonata por krei virtuan kaĝonon. Ruli ĉi tiun komandon:

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

Krei virtualan kutimon (venv): Rulum al via projekto radiko-direktoro kaj rulu:
```
python3 -m venv venv
```
*Aktivi la virtuaumon kaj instali pakojn ne antaŭ ol tio, aktivi la virtuaumon per:
```
source venv/bin/activate
```
Uzu requirement.txt: Tiu dosiero enhavas projekton dependiĝojn. Por instali ilin per pip, rulumu:
```
pip install -r requirements.txt
```

Instali Alilajn Modulojn: Instali aliajn Parrot-reponaj alsubmoduloj por inkludi iliajn dokumentaĵojn.

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

Konstruado de la dokumentado

Forigi ekzistantan konstruon: Se vi antaŭe konstruis la dokumentaron, komencu per forigado de la malnovaj konstruajn dosieroj kun ĉi tiu komando:
```
make clean
```
Krei la HTML-version de la dokumentoj: La aplikaĵo Parrot uzas Sphinx por generi sian dokumentacion. Por krei la HTML-version, rulumu:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Sendi al TTT-servilo

Post krei la dokumentaron, vi trovos la HTML-dosierojn en la build/html dosierujo. Tiuj estas la dosieroj, kiuj devas alŝutiĝi al via ttt-servilo.

Redakti .env por agordi la servila URL uzata de rsync, ekzemplo:

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

Plenumi la jenan komandon por rsync al la servilo:

./scripts/rsync-parrot-wtf

Vi tio pusos ĉiujn la HTML-dosierojn en build/html al via ĉefa servilo.

Note

La dokumentado de Parrot estas skribita en la angla, kaj uzas tradukcion de masinaro per inteligenta agento por aliaj lingvoj.