python-sphinx - example - sphinx python tutorial

Error de Sphinx: tipo de directiva desconocido "automodule" o "autoclass"

Question

Necesito documentar mi proyecto Python usando Sphinx. Pero no puedo usar autodoc .

Cuando configuro mi proyecto, selecciono la opción "autodoc extensión", pero ahora si uso

.. autoclass:: Class

Me sale un error:

ERROR: Unknown directive type "autoclass"

Configuré el PYTHONPATH , y ahora está bien. Pero ya tengo este problema.

Mi archivo de índice es:

.. 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`

Necesito que alguien me diga cómo puedo solucionar el problema.

Gracias

Answer 1

¡Lo mismo me pasó a mí! Para solucionarlo, vaya a la línea en conf.py que dice algo como esto:

extensions = [''sphinx.ext.todo'', ''sphinx.ext.viewcode'']

El tuyo probablemente se verá diferente. De todos modos, agregue ''sphinx.ext.autodoc'' a la lista. p.ej

extensions = [''sphinx.ext.todo'', ''sphinx.ext.viewcode'', ''sphinx.ext.autodoc'']

Si era:

extensions = []

entonces lo cambiarías a

extensions = [''sphinx.ext.autodoc'']

Fuentes: Documentación de Sphinx: ERROR: Tipo de directiva desconocido "programa-salida"