Forum Programmation.python Sphinx (analyseur de code) et automodule (résolu)

Posté par  (site web personnel) .
Étiquettes : aucune
0
3
nov.
2011

Bonjour à tous,
je veux documenter un projet écrit en Python 3 à l'aide de Sphinx(1) dont la dernière version est compatible avec Python 3.x . Je lance donc sphinx-quickstart, je renseigne conf.py pour expliquer où se trouve mon code et je modifie index.rst. A titre d'exemple, je crée un simple z.py (fichier avec une bête classe Z) dans le répertoire de code et je veux lancer un "automodule" sur ce fichier z.py. Voici index.rst :

Welcome to projetZ's documentation!
===================================

Contents:

.. toctree::
   :maxdepth: 2

.. warning::
   ESSAI DE WARNING

.. automodule:: z

Quand je lance un "make html" je récupère le message suivant : ERROR: Unknown directive type "automodule". Le reste du fichier passe bien mais d'où vient le problème avec le mot clef "automodule" ?

J'ai essayé de modifier la syntaxe de ma ligne "automodule", sans succès. Des recherches sur Internet ne m'apprennent rien. A tout hasard, j'ai essayé de changer da place mes fichiers source.

Merci de m'aider !

Je travaille sur une Archlinux à jour, avec Python 3 comme interpréteur python par défaut. J'ai fait le même test sur Mac OS X avec Python 2.6.1, avec le même résultat.

(1) http://sphinx.pocoo.org/tutorial.html

  • # réponse

    Posté par  (site web personnel) . Évalué à 2.

    Bon, j'ai trouvé : désolé, j'aurais dû mieux chercher. En lançant sphinx-quickstart il faut répondre y(es) à l'autoconf. Sinon, dans conf.py ajouter à 'extensions' la chaîne 'sphinx.ext.autodoc'.

    Merci à ceux qui m'ont lu !

    Trust the Python !

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.