python - 有狮身人面像报告断开的链接

Question

在构建 html 文档时，如何强制 sphinx 报告不存在的链接或创建错误？

具体来说，我的 Python 项目中有一些属性和方法已被删除或重命名，并且很难找到带有 sphinx 生成的 html 输出的所有死链接。

我觉得我正在盯着这里的答案: http://sphinx-doc.org/glossary.html ，如开篇所述。

我显然不明白什么。

Answer 1

设置nitpicky配置变量为 True(您也可以在运行 sphinx-build 时使用 -n option)。

在挑剔模式下，对函数(例如 :func:`myfunc`)、类或其他无法找到的对象的交叉引用将生成警告消息。