sphinxext-linkcheckdiff

Sphinx Extension to run diff-only linkchecks

Installation

python -m pip install https://github.com/TheTripleV/sphinxext-linkcheckdiff

Usage

Add sphinxext.linkcheckdiff to your extensions list in your conf.py

extensions = [
   sphinxext.linkcheckdiff,
]

Options

These values are placed in the conf.py of your sphinx project.

• linkcheckdiff_branch
  • Required. The branch to diff against.

Note: linkcheckdiff is an extension of the linkcheck builder that ships with Sphinx. linkcheckdiff respects all of linkcheck's configuration options.

Example Config

linkcheckdiff_branch = "master"