2. Documentação¶
2.1. Atualizar ou Adicionar Nova¶
Para adicionar nova ou atualizar a documentação, você deve adicionar ou alterar os arquivos existentes no formato RST, localizados em docs_src/source
Nota
Se você adicionou um novo arquivo, esteja certo de que você adicionou a referência no diretório docs_src/source/index.rst
2.2. Atualizar a tradução¶
Hoje temos 2 traduções, sendo `` en`` (inglês) e `` pt_BR`` (português), se você quiser adicionar mais uma, basta adicionar o prefixo do idioma que será gerado ou atualizado, localizado em docs_src/source/locale/
Gere os arquivos .po para atualizar
$ cd docs_src
$ make gettext
$ sphinx-intl update -p build/gettext -l pt_BR -l en
Atualizar os aquivos .po em
docs_src/source/locale/< Prefixo da LANGUAGE >/LC_MESSAGES/
Exemplo:
#: ../../source/index.rst:28
msgid "User Guide"
msgstr "Guia do Usuário"
Nota
O arquivo .mo irá ser gerado quando você gerar os aquivos HTML
2.3. Gerando a documentação¶
O projeto usa o GitHub Pages para hospedar os arquivos de documentação, então, todos os arquivos HTML devem estar localizados em /doc
$ cd docs_src
$ sphinx-build -b html source ../docs/en -D language='en'
$ sphinx-build -b html source ../docs/pt-br -D language='pt_BR'