Ce document est un fork du projet [modulo] (https://github.com/edunumsec2/book) pour l'enseignement pour l'informatique en discipline obligatoire au niveau Secondaire II dans le canton de Vaud pour mon propre enseignement. Le but est de produire une version compilable latex pouvant être distribuée sous forme de polycopié. Ces ressources ne seront pas directement utilisées en classe mais feront office de référence théorique à laquelle pourront se référer les élèves, par exemple pour réviser la théorie ou rattraper les cours manqués. Le polycopié sera mis à disposition des élèves qui pourront également le consulter en ligne en format web.
Modulo est basé sur le générateur de documentation Sphinx et utilise le template Furo.
- Python 3.x et pip (Installation MacOSX) (Installation Windows) (Installation rapide)
- virtualenv (
$ pip install virtualenv
) - Git
- latex
Pour vérifier la bonne installation de l'environnement de base :
$ python --version
$ virtualenv --version
$ git --version
- Récupération du projet :
git clone [email protected]:mihersch/book.git
- Vers la racine du projet :
cd book
- Création d'un environnement virtuel :
virtualenv .env
- Activation de l'environnement virtuel :
- Sur MacOS :
source .env/bin/activate
- Sur Windows :
.env\Scripts\activate
- Installation des librairies dans l'environnement virtuel :
pip install -r requirements.txt -U
Remarque : à chaque fois que vous travaillez sur le projet, l'environnement virtuel devrait être activé (point 4).
- Activation de l'environnement virtuel (si pas déjà fait)
- Compilation :
- 'latex' :
sphinx-build -E -b latex src/appr build/latex/appr
génère les fichiers latex dans le répertoirebuild/latex/appr'. Ces fichiers peuvent ensuite être compilé en un pdf, par exemple en utilisant
pdflatex modulo2` dans ce répertoire. - 'html :
sphinx-build -E -b latex src/appr build/appr
génère les fichiers html dans le répertoirebuild/appr
.
La génération du document peut être paramétrée (pour latex et ou html) en modifiant le fichier src/appr/conf.py
Ce document est disponible sous licence Creative Commons CC-BY-NC