未知指令类型“ toctree”。 Pycharm错误，但index.html可以工作

Question

在PyCharm中工作时，我在Sphinx中创建的文档的预览模式显示为：

System Message: ERROR/3 (<stdin>, line 9)

Unknown directive type "toctree".

..toctree::
 :maxdepth: 2

 file1
 file2

我已在conf.py文件中包含autodoc扩展名。当我打开/build/index.html文件时，它工作正常。因此，我的问题是：如何从PyCharm预览模式中消除此错误，以便可以预览文档而不必一直打开/build/index.html文件？

Answer 1

Sphinx建立在Docutils库的顶部。 toctree指令可用于Sphinx，但Docutils无法识别。

PyCharm预览器未使用Sphinx（自2019年起，免费社区版和专业版均是如此）；它可能使用Docutils中的rst2html.py。

此邮件列表线程大约具有相同的错误：https://web.archive.org/web/20180715103227/https://mail.python.org/pipermail/python-list/2008-June/493826.html