Question

我需要使用Sphinx记录我的Python项目。但我无法使用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`

我需要有人告诉我如何解决问题。

谢谢

Answer 1

同样的事发生在我身上！要修复它，请转到conf.py中的行，其中包含以下内容：

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

你的看起来可能会有所不同。无论如何，将'sphinx.ext.autodoc'添加到列表中。 e.g。

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

如果是：

extensions = []

然后你将它改为：

extensions = ['sphinx.ext.autodoc']

资料来源：Sphinx documentation: ERROR: Unknown directive type "program-output"

Sphinx错误：未知指令类型“automodule”或“autoclass”

1 个答案: