From 16a316eed5b49138b49a65856d30bef58a0e1570 Mon Sep 17 00:00:00 2001
From: Djalim Simaila <DjalimS.pro@outlook.fr>
Date: Mon, 22 May 2023 13:33:08 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(README.md):=20add=20instruc?=
 =?UTF-8?q?tions=20for=20generating=20documentation=20using=20Sphinx=20and?=
 =?UTF-8?q?=20readthedocs=20theme=20Added=20instructions=20for=20generatin?=
 =?UTF-8?q?g=20documentation=20using=20Sphinx=20and=20the=20readthedocs=20?=
 =?UTF-8?q?theme.=20The=20documentation=20can=20be=20found=20in=20the=20`d?=
 =?UTF-8?q?ocs/build`=20directory=20and=20can=20be=20opened=20by=20launchi?=
 =?UTF-8?q?ng=20the=20`index.html`=20file=20in=20a=20web=20browser.=20The?=
 =?UTF-8?q?=20instructions=20include=20installing=20the=20readthedocs=20th?=
 =?UTF-8?q?eme=20and=20running=20the=20`make=20html`=20command=20in=20the?=
 =?UTF-8?q?=20`docs`=20directory=20to=20generate=20the=20documentation.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

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