Ошибка Sphinx: неизвестный тип директивы automdule или autoclass

Мне нужно задокументировать мой проект Python с помощью Sphinx. Но я не могу использовать autodoc.

Когда я настраиваю свой проект, я выбираю опцию «extension autodoc», но теперь, если я использую

.. autoclass:: Class

Я получаю сообщение об ошибке:

ERROR: Unknown directive type "autoclass"

Настраиваю PYTHONPATH, и теперь все хорошо. Но у меня уже есть эта проблема.

Мой индексный файл:

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

Мне нужно, чтобы кто-нибудь сказал мне, как я могу решить эту проблему.

Спасибо


python-sphinx autodoc
person edgarzamora    schedule 22.11.2012    source источник
comment
Включен ли sphinx.ext.autodoc в переменную конфигурации extensions в conf.py?   -  person mzjn    schedule 23.11.2012

Ответы (1)


arrow_upward
136
arrow_downward

Тоже самое произошло со мной! Чтобы исправить это, перейдите к строке в conf.py, в которой написано что-то вроде этого:

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

Ваш, вероятно, будет выглядеть иначе. В любом случае добавьте 'sphinx.ext.autodoc' в список. например

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

Если бы это было:

extensions = []

тогда вы бы изменили его на:

extensions = ['sphinx.ext.autodoc']

Источники: Документация Sphinx: ОШИБКА: вывод программы неизвестного типа

person kirbyfan64sos    schedule 08.06.2013