diff --git a/README.md b/README.md index 9decf78..f53a4cb 100644 --- a/README.md +++ b/README.md @@ -105,12 +105,9 @@ ___ - Le code est commenté et documenté en anglais. - Le backend du rendu de graphe "matplotlib" n'est (actuellement) pas compatible avec le programme. Il peut cepandant etre utilisé independamment du programme pour des scripts ou des notesbooks. -La documentation du code est disponible en la generant avec [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) -et en faisant la commande suivante : `make html` dans le dossier docs. Stack trace de l'analyse d'un fichier .obj : - ```mermaid flowchart TD A(app.py)-- calls --> B(MainWindow.py) @@ -125,6 +122,20 @@ flowchart TD E -- When finished triggers and calls in a thread --> F(AdvancedDataWorker.py) F -- Stores results in --> B ``` + +La documentation du code est dans le dossier builded doc, il suffit d'ouvrir le fichier index.html avec un navigateur web. + +Pour generer la documentation apres modification du code il faut passer par [sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html), +ensuite il faut installer le theme [readthedocs](https://sphinx-rtd-theme.readthedocs.io/en/stable/) +```bash +pip install sphinx_rtd_theme +``` +et executer la commande suivante dans le dossier doc : +```bash +make html +``` +Cela generera la documentation dans le dossier docs/build. + --- ## Contributeurs