pycharm - 未知指令类型“toctree”。Pycharm 中的错误，但 index.html 有效

Question

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

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

Unknown directive type "toctree".

..toctree::
 :maxdepth: 2

file1
file2

我已将autodoc扩展名包含在我的 conf.py 文件中。当我打开 /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