故障排除

静态页面问题

为什么我的页面没有显示在目录菜单中?

检查您的页面是否在index.rst文件中正确列出(请检查indent!) example .

检查你看的是正确的分支阅读文档

为什么页面加载/显示不正确?

检查source restructuredtext文件是否存在rstcheck问题。

安装rst check(如果您还没有)检查rst代码的语法:

sudo pip install rstcheck

针对特定文件运行:

rstcheck <file>

或者对目录中的所有RestructedText文件运行它:

rstcheck *.rst

如果没有返回任何结果,则RestructuredText是良好的。

AutoDoc问题

模块文件丢失或不完整

检查阅读文档,查看是否存在导入问题,如 example-of-import-problem

如果您的代码有子模块(即代码在多个目录级别中),那么您可能需要 alter your path statement .