have sphinx report broken links

前端 未结 2 1456
悲哀的现实
悲哀的现实 2021-01-04 07:09

When building html documentation, how do you force sphinx to report, or create an error, on links that don\'t exist?

Specifically, I have properties and methods with

2条回答
  •  -上瘾入骨i
    2021-01-04 07:58

    I think CheckExternalLinksBuilder is what you're looking for.

    It's basically used by calling 'sphinx-build' with -b linkcheck option. Please see sphinx-build for more info. Also, take a look at the list of sphinx-extensions here and here.

提交回复
热议问题