Source Code

Source code repository for this documentation.

https://spacecruft.org/deepcrayon/transpolibre

Note, this is how to build documentation for the transpolibre application itself, not how to use transpolibre.

Build Documentation

To build this documentation locally, do thusly.

Install Dependencies

Install dependencies, such as with Debian:

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

Download Documentation Source

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

Setup Python

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

Documentation Build Help

For documentation build help, run:

make help

This will display this help:

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

Clean

Clean build artifacts thusly.

make clean

Build HTML Documentation

To build the HTML documentation, run:

make index
make html

The resulting HTML will be in docs/_build/html/ with a top-level index.html file located here: docs/index.html.

Build LaTex PDF

To build a PDF document from a LaTeX build, first install dependencies (this is way more than needed):

sudo apt install texlive-full

Then build the LaTeX and PDF documents:

make latex

Build PDF

To build a PDF document from LaTeX:

make pdf

The resulting PDF will be here: docs/_build/latex/en/transpolibre.pdf.

eBook

To greatly reduce the size of the PDF to 150 dpi for an eBook, run:

make ebook

The resulting PDF will be here: docs/_build/latex/en/transpolibre-ebook-en.pdf.

Prepress

To reduce the size of the PDF to 300 dpi for printing, run:

make prepress

The resulting PDF will be here: docs/_build/latex/en/transpolibre-prepress-en.pdf.

Build All Documentation

To build all documentation, including HTML and PDFs.

make all

Translations

See README.md for notes on how to update package translations.