Sphinx-Fehler: Unbekannter Anweisungstyp "Automodul" oder "Autoklasse"

74

Ich muss mein Python-Projekt mit Sphinx dokumentieren. Aber ich kann nicht verwenden autodoc.

Wenn ich mein Projekt konfiguriere, wähle ich die Option "Erweiterung autodoc", aber jetzt, wenn ich benutze

.. autoclass:: Class

Ich erhalte eine Fehlermeldung:

ERROR: Unknown directive type "autoclass"

Ich konfiguriere das PYTHONPATHund jetzt ist es gut. Aber ich habe dieses Problem bereits.

Meine Indexdatei lautet:

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

Ich brauche jemanden, der mir sagt, wie ich das Problem beheben kann.

Vielen Dank

Edgarzamora
quelle
13
Ist "sphinx.ext.autodoc" in der extensionsKonfigurationsvariablen in conf.py enthalten?
Mzjn

Antworten:

119

Mir geht es genauso! Um das Problem zu beheben, gehen Sie zu der Zeile in conf.py, in der etwa Folgendes steht:

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

Ihre wird wahrscheinlich anders aussehen. Wie auch immer, 'sphinx.ext.autodoc'zur Liste hinzufügen . z.B

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

Wenn es war:

extensions = []

dann würden Sie es ändern zu:

extensions = ['sphinx.ext.autodoc']

Quellen: Sphinx-Dokumentation: FEHLER: Unbekannter Direktiventyp "Programmausgabe"

kirbyfan64sos
quelle