Documentação

Atualizar ou adicionar novas páginas

Os arquivos-fonte da documentação ficam em docs_src/source e usam o formato RST. As traduções ficam em docs_src/source/locale/<language>/LC_MESSAGES como arquivos gettext .po.

Nota

Se você adicionar uma nova página, inclua-a em docs_src/source/index.rst ou em um toctree filho, depois execute make docs para atualizar os catálogos de tradução.

Gerando a documentação

Gere a documentação HTML bilíngue localmente:

make docs

A documentação gerada é escrita em docs:

• docs/index.html é o seletor de idioma.

• docs/en/ contém a documentação em inglês.

• docs/pt-br/ contém a documentação em português.

• docs/.nojekyll e docs/.buildinfo são criados na raiz para o GitHub Pages.

Limpando a documentação gerada

make clean-docs