在构建html文档时,如何强制sphinx在不存在的链接上报告或创建错误?
具体来说,我的Python项目中的属性和方法已被删除或重命名,并且很难找到sphinx生成的html输出的所有死链接。
我觉得我在这里盯着答案: http://sphinx-doc.org/glossary.html,如开头段落中所述。
我显然不理解某事。
答案 0 :(得分:13)
将nitpicky配置变量设置为True
(运行sphinx-build时也可以使用-n option。)
在nitpicky模式下,对函数(例如:func:`myfunc`
),类或其他无法找到的对象的交叉引用将生成警告消息。
答案 1 :(得分:5)
我认为CheckExternalLinksBuilder
正是您所寻找的。
它基本上是通过使用-b linkcheck
选项调用'sphinx-build'来使用的。有关详细信息,请参阅sphinx-build
。另外,请查看sphinx-extensions列表here和here。