python - 有 sphinx 报告断开的链接

Question

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

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

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

我显然不明白一些事情。

Answer 1

将nitpicky配置变量设置为（运行 sphinx-build 时True也可以使用-n 选项）。

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

Answer 2

我想CheckExternalLinksBuilder这就是你要找的。

它基本上是通过使用选项调用“sphinx-build”来使用的-b linkcheck。请参阅sphinx-build以获取更多信息。另外，请查看此处和此处的 sphinx-extensions 列表。