让Sphinx报告断开的链接

Question

在制作HTML文档时，怎么让sphinx报告不存在的链接，或者说产生一个错误呢？

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

我觉得我快要找到答案了，参考这个链接：http://sphinx-doc.org/glossary.html，就像开头那段描述的。

显然，我有些地方没有理解透彻。

Answer 1

我觉得你需要的是 CheckExternalLinksBuilder。

这个工具的用法很简单，你只需要在使用 'sphinx-build' 命令时加上 -b linkcheck 这个选项就可以了。想了解更多信息，可以查看 sphinx-build 的说明。此外，你还可以看看这两个链接里的 Sphinx 扩展列表：这里 和 这里。

Answer 2

把 nitpicky 这个配置选项设置为 True（你在运行 sphinx-build 的时候也可以使用 -n 选项）。

在 nitpicky 模式下，如果你引用了一个找不到的函数（比如 :func:`myfunc`）、类或者其他对象，就会出现警告信息。