Código-fonte

Repositório do código-fonte para esta documentação.

https://spacecruft.org/deepcrayon/transpolibre

Note, esta é a forma de construir a documentação para a própria aplicação transpolibre, não como usar o transpolibre.

Criar documentação

Para construir esta documentação localmente, faça o seguinte.

Instalar dependências

Instale as dependências, como no Debian:

sudo apt update
sudo apt install python-is-python3 python3-pip python3-venv

Baixar documentação Fonte

git clone https://spacecruft.org/deepcrayon/transpolibre
cd transpolibre/

Configurando o Python

python -m venv venv
source venv/bin/activate
pip install -U pip setuptools wheel

Documentação Ajuda de compilação

Para obter ajuda na compilação da documentação, execute:

make help

Isto irá exibir esta ajuda:

Please use 'make <target>' where <target> is one of
  clean                Remove all build files and directories (including translations)
  all                  Clean and make all targets
  gettext_build        Build localisation strings for translation
  update_locale        Update localisation
  update_locale_<lang> Update localisation for <lang>
  html                 Build the HTML documentation for all languages
  html_<lang>          Build HTML documentation for <lang>
  latex                Build the documentation using LaTeX for all languages
  latex_<lang>         Build the documentation using LaTeX for <lang>
  pdf                  Build the PDF documentation using LaTeX for all languages
  pdf_<lang>           Build the PDF documentation using LaTeX for <lang>
  ebook                Reduce size of PDF for eBook
  prepress             Reduce size of PDF for prepess
  index                Copy static docs/index.html to docs/_build/html/index.html
  translations         Translate from English

Limpo

Limpe os artefatos de compilação assim.

make clean

Criar documentação HTML

Para construir a documentação HTML, execute:

make index
make html

O HTML resultante estará em docs/_build/html/ com um arquivo index.html de nível superior localizado aqui: docs/index.html.

Criar um PDF em LaTex

Para criar um documento PDF a partir de uma compilação LaTeX, primeiro instale as dependências (isso é muito mais do que o necessário):

sudo apt install texlive-full

Em seguida, crie os documentos LaTeX e PDF:

make latex

Criar PDF

Para criar um documento PDF a partir do LaTeX:

make pdf

O PDF resultante estará aqui: docs/_build/latex/en/transpolibre.pdf.

eBook

Para reduzir consideravelmente o tamanho do PDF para 150 dpi para um eBook, execute:

make ebook

O PDF resultante estará aqui: docs/_build/latex/en/transpolibre-ebook-en.pdf.

Pré-impressão

Para reduzir o tamanho do PDF para 300 dpi para impressão, execute:

make prepress

O PDF resultante estará aqui: docs/_build/latex/en/transpolibre-prepress-en.pdf.

Compilar toda a documentação

Para construir toda a documentação, incluindo HTML e PDFs.

make all

Traduções

Consulte o README.md para obter notas sobre como atualizar as traduções do pacote.