90

我需要使用 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`

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

谢谢

4

1 回答 1

150

这样的事情我也经历过!要修复它,请转到 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 文档:错误:未知指令类型“程序输出”

于 2013-06-08T23:16:59.413 回答