Construir Documentação

Este documento explica como construir a documentação Sphinx para o aplicativo Parrot. Abordaremos a configuração de um ambiente virtual (venv), a instalação do pip e o uso do requirements.txt, a

Nota

Parrot is in early development, not ready for end users.

Instruções de configuração

Clone the repository: First, clone the repository using this command:

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

Altere o diretório para o repositório: Após clonar, navegue até o diretório raiz do projeto executando:
```
cd parrot-wtf
```

Instale o python3-venv (apt): Isso é necessário para criar um ambiente virtual. Execute este comando:

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

Configure um ambiente virtual (venv): Navegue até o diretório raiz do seu projeto e execute:
```
python3 -m venv venv
```
Ative o ambiente virtual: Antes de instalar quaisquer pacotes, ative o ambiente virtual executando:
```
source venv/bin/activate
```
Utilize o requirements.txt: Este arquivo contém uma lista de dependências do projeto. Para instalá-los usando o pip, execute:
```
pip install -r requirements.txt
```

Instale Submódulos: Instale outros submódulos do repositório Parrot para incluir sua documentação.

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

Construindo a Documentação

Limpar a construção existente: Se você já construiu a documentação, comece limpando os arquivos de construção antigos com este comando:
```
make clean
```
Construa a versão HTML dos documentos: O aplicativo Parrot usa o Sphinx para gerar sua documentação. Para criar a versão HTML, execute:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Enviar para o Servidor da Web

Após construir a documentação, você encontrará os arquivos HTML no diretório build/html. Esses são os arquivos que precisam ser enviados ao seu servidor web.

Edite o arquivo .env para definir a URL do servidor a ser utilizado pelo rsync, como:

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

Execute o seguinte comando para rsync no servidor:

./scripts/rsync-parrot-wtf

Isto irá enviar todos os arquivos HTML em build/html para o seu servidor principal.

Nota

A documentação do Parrot é escrita em inglês e utiliza a tradução automática de máquina para outras línguas.