Après une installation parfaite de Sphinx,

1. Dans le dossier où sera créée la documentation, ouvrir un terminal
2. Y taper sphinx-quickstart docs et répondre aux 5 questions :
   1. Séparer les répertoires build et source (y/n) [n]: (tapez : y)
   2. Nom du projet: (par exemple : test)
   3. Nom(s) de l'auteur: (par exemple : moi)
   4. version du projet []: (par exemple : 0.1 ou AAAA-MM-JJ)
   5. Langue du projet [en]: (ne tapez rien ou fr)

   Cela créera le dossier /docs et d'autres sous-dossiers.

3. Configurer le fichier config.py, situé dans le dossier /docs/source, tel que

   import os  # ligne décommentée
   import sys # ligne décommentée
   
   # Chemin sous Linux
   #sys.path.append('/home/.../docs/source')
   
   # Chemin sous Windows
   #sys.path.append('C:\...\docs\source')
   
   # Une des deux lignes "sys.path.append(..." doit être décommentée.
   
   
   
   extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary'
   ]
   
   
   
   html_theme = 'classic' # modification facultative
   

4. Coller dans le dossier /docs/source le fichier, écrit en Python, à documenter.
5. Coller dans le dossier /docs le programme autodoc.py, situé dans le dossier ...\cours\pgm\sphinx\docs
6. Dans un Terminal ouvert dans le dossier /docs, lancer le programme autodoc.py
python autodoc.py. Et, répondre aux questions posées.
7. Convertir l'encodage du fichier details_xxx.rst, généré, en UTF-8.
8. Déplacer l'éventuel fichier xxx.dot dans le dossier ...\cours\logiciels\graphviz\exe contenant le fichier dot.exe
   et tapez, dans le Terminal, ouvert dans le dossier contenant dot.exe,
   dot -Tsvg xxx.dot > xxx.svg
9. Après avoir tapé make html dans le terminal ouvert dans le dossier /docs, contenant le fichier make.bat, devrait s'afficher :
   The HTML pages are in build\html.

Le présent dossier contient :

- Le dossier /docs et le fichier README.rst sont issues de l'outil Sphinx lors
du "quick-start"

- Les autres dossiers et fichiers sont une copie du dossier /docs/build/html
Ils existent donc en double.

Toutefois, les fichiers /_sources/*.rst.txt sont (ou devraient être recodés) en latin15 (pour être lisibles depuis un navigateur), via gedit > enregistrer sous > latin 15 > écraser


---------------

Pour extraire les docstrings du code JavaScript :
https://pypi.org/project/sphinx-js/



Avant "make html", les fichiers .rst doivent être encodés en UTF-8
Sous Windows, via NotePad++, ils peuvent être convertis en UTF-8 (après avoir fait une copie de sécurité)

TODO : Vérifier que le programme autodoc.py tient compte des class