Ajout des infos pour générer un PDF

master
youen 3 years ago
parent
commit
a1a1444d42
  1. 29
      Compiler-la-documentation.md

29
Compiler-la-documentation.md

@ -11,11 +11,11 @@ Nous supposons pour la suite que le projet de documentation est structuré ainsi
```
projet-de-documentation
├─ dist
│ ├─ html
│ └─ pdf
├─ build
├─ outils
└─ source
├─ source
├─ make.bat
└─ Makefile
```
Créer une environnement virtuel python. Cela permet d'installer des modules python qui ne seront utilisés que par ce projet (et donc d'avoir d'autres modules, ou d'autres versions des mêmes modules, dans d'autres projets).
@ -39,10 +39,27 @@ pip install -U pip setuptools wheel
pip install Sphinx myst-parser sphinx_rtd_theme linkify-it-py
```
## Prise en charge du format PDF
Pour pouvoir compiler la documentation dans un fichier PDF, le système nécessite un passage par Latex. Il faut installer des paquets supplémentaires :
``` shell
sudo apt install fonts-freefont-otf latexmk texlive-fonts-recommended texlive-latex-recommended texlive-latex-extra texlive-lang-french tex-gyre texlive-xetex
```
# Générer la documentation au format HTML
``` shell
cd projet-de-documentation
source outils/bin/activate
sphinx-build -b html source dist/html
```
make html
```
# Générer la documentation au format PDF
``` shell
cd projet-de-documentation
source outils/bin/activate
make latexpdf
```

Loading…
Cancel
Save