Documentation de vMap

Pour développer en local, il faut ouvrir un invite de commandes, ou un terminal powershell à la racine du fichier doumentation, modifier ou rajouter des fichier markdown, puis taper la commande :

Il faut avoir python, et également sphinx et les différents outils utilisés par sphinx :

pip install -U sphinx
pip install sphinx_rtd_theme==0.5.2
pip install sphinx-markdown-parser
pip install myst-parser
pip install pymdown-extensions
sphinx-build -b html doc/source doc/build

On peut ensuite visualiser le site dans le dossier "build" puis ouvrir le fichier index.html.

Une fois que les modifications sont terminées, il suffit de push sur gitlab, et le site sera automatiquement déployé.