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

Question

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

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

我觉得我正在盯着这里的答案: http://sphinx-doc.org/glossary.html,正如开头段落中所描述的那样.

我显然不理解某些事情.

Answer 1

将nitpicky配置变量设置为True(运行sphinx-build时也可以使用-n选项).

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

Answer 2

我认为CheckExternalLinksBuilder这就是你要找的东西.

它基本上是通过-b linkcheck选项调用'sphinx-build'来使用的.请参阅sphinx-build更多信息.另外,请在这里和这里查看 sphinx扩展列表.