Ce dépôt constitue une base (template) pour réaliser la documentation de votre projet en utilisant le système de documentation Sphinx, également utilisé pour documenter l'interpréteur Python.
Pour éditer votre documentation avec gitpod.io, suivez les étapes suivantes
- Faites un fork de ce dépôt dans votre propre compte GitHub
- Ouvrez votre fork dans gitpod (rajouter https://gitpod.io/# avec l'URL du dépôt dans GitHub), par exemple https://gitpod.io/#https://github.com/oci-2224/sphinx-template
- Dans le dossier
source, modifiez le fichierinfos.pyavec vos informations personnelles adaptées pour votre projet
Le fichier infos.py avec vos informations personnelles vautomatiquement
importé dans le module conf.py qui permet de configurer Sphinx.
Pour compiler les fichiers Sphinx en HTML, il faut entrer la commande suivante depuis le dossier racine du projet contenant le fichier Makefile :
make livehtmlPour pouvoir générer le PDF, il faut au préalable installer LaTeX sur le système. Sur un système Linux, il suffit de faire les commandes
sudo apt update
sudo apt-get install texlive-latex-extra texlive-lang-french texlive-fonts-recommended latexmkSur les machines Windows, l'installation risque d'être plus compliquée, raison pour laquelle il est conseillé de compiler votre travail directement dans gitpod ou dans le Bash Ubuntu de Windows 10.
Ensuite, pour générer le PDF, il suffit de faire depuis la racine du dépôt où se trouve le fichier Makefile principal :
make tmpdfet de se rendre dans le dossier build/latex/ et ouvrir le fichier tm-ecrit.pdf généré par LaTeX.
Il suffit ensuite, pour visualiser le résultat, de visiter http://localhost:8000/ dans le navigateur Web.
Le plus simple, pour démarrer, est de forker ce dépôt dans votre propre compte GitHub et cloner ce dernier sur votre machine locale ou dans un IDE en ligne tel que Gitpod.