Guia de teste

Este é um guia de teste da tradução da documentação do Python.

Ainda estamos trabalhando neste guia. Em breve, esta página estará repleta de informações.

Testar a tradução, em que pese não ser obrigatório, ajuda a garantir tradução conforme contexto, a garantir a correta conjugação verbal em cada caso, a evitar erros de sintaxe ReStructuredText e outros erros.

Preparando o ambiente

Sistema operacional

Atualmente, a maioria destas instruções são compatíveis apenas com Linux, de forma que Windows e macOS podem não funcionar sem ajustes não testados e não mencionados aqui.

Quando as instruções funcionarem em outro sistema, será mencionado no local específico.

Instalar programas necessários

Os seguintes comandos devem estar disponíveis para os testes funcionarem:

• msgcat e outras ferramentas incluídas no Gettext (normalmente já instalado nas distros Linux)
• git
• make
• python3

Configurar transifex-client

Esta seção fornece os passos para configuração do tx, a ferramenta de linha de comando do Transifex.

1. Gere um token de API no Transifex em Configurações do Usuário > Token API. Copie-o, pois só será mostrado uma vez!
2. Crie um arquivo .transifexrc com seu token de API e seu nome de usuário:

[https://www.transifex.com]
api_hostname = https://api.transifex.com
hostname = https://www.transifex.com
password = <seu token de API>
username = <seu nome de usuário>

Consulte a seção .transifexrc em Configuration Files para mais informações.

Clonar o repositório

Escolha um diretório onde gostaria de manter a cópia local do repositório e execute:

git clone https://github.com/python/python-docs-pt-br

Tenha em mente que a execução o script de compilação baixará e utilizará uma cópia do repositório do cpython ao lado do repositório local (isto é, ../cpython de dentro do python-docs-pt-br)

Testando tradução

Compilar a documentação traduzida

Dentro do diretório python-docs-pt-br, execute:

make build

Este comando vai instalar pacotes do PyPI, clonar o repositório cpython e demais ajustes necessários, para então compilar a documentação.

Este comando não baixa traduções do transifex, apenas usa as traduções disponíveis no python-docs-pt-br local. Caso queira baixar do Transifex, use make pull, o que pode demorar 30 minutos.

Avisos são, por padrão, tratados como erro. Então, havendo um erro de sintaxe ReStructuredText que é considerado aviso, será mostrado como erro.

Baixar uma tradução do Transifex

Isto é muito útil quando se deseja testar uma tradução específica que ainda não foi publicada, mas que está no Transifex.

Antes de baixar a tradução, certifique-se de ter os pacotes do PyPI instalados no ambiente virtual, executando:

make venv 

Então, o comando é o seguinte:

venv\bin\tx -fr <projeto>.<recurso>

sendo <projeto> sempre python-newest, que é o projeto ("versão") que deve receber tradução, e <recurso> o nome do recurso que você traduziu no Transifex, como library--os, reference--datamodel, whatsnew--3_9 etc.

Por exemplo, para baixar a tradução de library--os, o comando seria:

venv\bin\tx -fr python-newest.library--os

Baixado com sucesso, agora você pode Compilar a documentação traduzida. Em seguida, pode Servir em um servidor web local.

Servir em um servidor web local

Para ver como a documentação traduzida compilada ficou, você pode iniciar um servidor web local com um simples comando.

Mas antes de servir, certifique-se de Compilar a documentação traduzida.

Para servir a documentação, execute:

make serve

Sua documentação deve estar disponível em http://localhost:8000.

Verificar ortografia