J'ai besoin de documenter mon Python utilisant Sphinx. Mais je ne peux pas utiliser autodoc
.
Quand je configure mon projet je sélectionne l'option "extension autodoc", mais maintenant si j'utilise
.. autoclass:: Class
Je reçois une erreur:
ERROR: Unknown directive type "autoclass"
Je configure le PYTHONPATH
, et maintenant c'est bon. Mais j'ai déjà ce problème.
Mon fichier d'index est:
.. ATOM documentation master file, created by
sphinx-quickstart on Thu Nov 22 15:24:42 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to ATOM's documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
.. automodule:: atom
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
J'ai besoin que quelqu'un me dise comment je peux résoudre le problème.
Je vous remercie
La même chose m'est arrivée! Pour le corriger, allez à la ligne dans conf.py qui dit quelque chose comme ceci:
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode']
Le vôtre sera probablement différent. Quoi qu'il en soit, ajoutez 'sphinx.ext.autodoc'
à la liste. par exemple.
extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc']
Si c'était:
extensions = []
alors vous le changeriez en:
extensions = ['sphinx.ext.autodoc']
Sources: documentation Sphinx: ERREUR: type de directive inconnu "sortie de programme"