有 sphinx 报告断开的链接答案

【问题标题】：have sphinx report broken links有 sphinx 报告断开的链接
【发布时间】：2019-08-20 21:43:06
【问题描述】：

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

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

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

我显然不明白一些事情。

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

【解决方案2】：

我认为CheckExternalLinksBuilder 是您正在寻找的。

它基本上是通过使用-b linkcheck 选项调用“sphinx-build”来使用的。请参阅sphinx-build 了解更多信息。另外，请查看 sphinx 扩展列表 here 和 here。

【讨论】：