Parcourir la source

Ajout de la documentation de contribution à la doc

Scara il y a 9 ans
Parent
commit
dfcc509ce2
1 fichiers modifiés avec 13 ajouts et 1 suppressions
  1. 13 1
      docs/docs/contribuer.md

+ 13 - 1
docs/docs/contribuer.md

@@ -4,4 +4,16 @@ Se référer aux instructions du fichier [README](https://code.ffdn.org/jocelyn/
 
 À la documentation
 ==================
-TODO
+Se référer aux instructions du fichier [README](https://code.ffdn.org/jocelyn/transparency/src/master/README.md) pour la partie de configuration de l'environnement.
+
+Ensuite, il suffira de taper deux commandes à chaque fois pour visualiser localement la documentation de Transparency :
+
+  `$ source <chemin>/transparency/docs/venv/bin/activate`
+
+L'invite de commande commence alors par **(venv)**
+
+Puis en se plaçant dans le dossier **docs/docs** du dépot *transparency*
+
+  `$ mkdocs serve`
+
+La documentation est visualisable dans un navigateur Internet à l'url [127.0.0.1:8000](http://127.0.0.1:8000/).