Code source

Répértoire du code source pour cette documentation.

https://spacecruft.org/deepcrayon/transpolibre

Notez que c’est la façon de construire la documentation pour l’application transpolibre elle-même, pas la façon d’utiliser transpolibre.

Créer la documentation

Pour construire cette documentation localement, procédez comme suit.

Installer les dépendances

Installez les dépendances, comme avec Debian :

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

Télécharger la documentation Source

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

Configuration de Python

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

Documentation Build Help

Pour de l’aide sur la création de la documentation, lancez :

make help

Cela affichera cette aide :

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

Propre

Nettoyez les artefacts de construction de la manière suivante.

make clean

Générer une documentation HTML

Pour construire la documentation HTML, lancez :

make index
make html

Le code HTML résultant sera dans docs/_build/html/ avec un fichier index.html de haut niveau situé ici : docs/index.html.

Créer un PDF LaTex

Pour construire un document PDF à partir d’une construction LaTeX, installez d’abord les dépendances (c’est bien plus que nécessaire) :

sudo apt install texlive-full

Puis, construisez les documents LaTeX et PDF :

make latex

Créer des PDF

Pour construire un document PDF à partir de LaTeX :

make pdf

Le fichier PDF résultant sera ici : docs/_build/latex/fr/transpolibre.pdf.

eBook

Pour réduire considérablement la taille du PDF à 150 dpi pour un eBook, exécutez :

make ebook

Le PDF résultant sera ici : docs/_build/latex/fr/transpolibre-ebook-fr.pdf.

Prépresse

Pour réduire la taille du fichier PDF à 300 dpi pour l’impression, exécutez :

make prepress

Le fichier PDF résultant sera ici : docs/_build/latex/fr/transpolibre-prepress-fr.pdf.

Générer toute la documentation

Pour construire toute la documentation, y compris les fichiers HTML et PDF.

make all

Traductions

Voir « README.md » pour des notes sur la façon de mettre à jour les traductions des paquets.