sphinxext-linkcheckdiff

Sphinx扩展，用于运行仅diff链接检查

安装

python -m pip install git+https://github.com/wpilibsuite/sphinxext-linkcheckdiff

使用

将 sphinxext.linkcheckdiff 添加到您的 conf.py 中的扩展列表

extensions = [
   sphinxext.linkcheckdiff,
]

选项

这些值放置在您的sphinx项目的conf.py中。

• linkcheckdiff_branch
  • 必需的。与diff进行比较的分支。

注意：linkcheckdiff是Sphinx附带linkcheck构建器的扩展。linkcheckdiff尊重linkcheck的所有配置选项。

示例配置

linkcheckdiff_branch = "master"