Mon expérience de Sphinx:
Par curiosité, je viens de passer 3 heures à installer, configurer et utiliser Sphinx, et ma conclusion, c'est que ce logiciel est une véritable punition.
J'ai appliqué ce que j'ai vu dans la doc, dans le présent fil ainsi que dans une vingtaine de pages web.
Pour installer sphinx sous Windows, il faut installer:
- setuptools (pour avoir easy_install, nécessaire pour installer les .egg)
- docutils (pour avoir reStructuredText)
- Jinja2
- Pygments
- puis, enfin, Sphinx
Une fois installé tout ça, il faut:
- ajouter à la main le chemin des binaires c:\Python27\Scripts dans le path de windows, et mettre à jour ou créer le PYTHONPATH qui doit pointer sur le répertoire contenant le module à documenter (panneau de configuration => system).
- créer le répertoire de la future doc
- Dans une console, se placer dans le répertoire de la future doc, et faire sphinx-quickstart. Répondre aux différentes questions (automodule=yes).
- modifier index.rst et ajouter
- puis, faire
Code : Sélectionner tout - Visualiser dans une fenêtre à part
1
2 .. automodule:: monmodule .. autoclass:: laclassedemonmodule
A la fin, il me sort une superbe page html dans laquelle il me répète le nom du module que je lui ai donné (bravo!), la classe que je lui ai donnée dans ce module (même pas fichu de la trouver tout seul?) et le docstring de cette classe (seul travail utile qu'il a fait). Mais rien d'autre!
Code : Sélectionner tout - Visualiser dans une fenêtre à part make html
Tout ça pour ça?
Que faut-il faire pour avoir tout le reste: les fonctions et les méthodes avec leurs docstring, les ascendances des classes, les variables globales, les importations, etc...???
J'aimerais bien obtenir de Sphinx AU MOINS ce que j'ai obtenu facilement avec epydoc.
Merci d'avance au bienfaiteur qui pourra me donner un coup de pouce!
Partager