未知指令类型 "toctree"。 Pycharm 出错,但 index.html 有效
Unknown directive type "toctree". Error in Pycharm, but index.html works
在 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 文件?
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
在 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 文件?
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