Sphinx Extension to run diff-only linkchecks
Project description
sphinxext-linkcheckdiff
Sphinx Extension to run diff-only linkchecks
Installation
python -m pip install git+https://github.com/wpilibsuite/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"
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxext-linkcheckdiff-0.1.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c134d21efafa6a21e209e8181d58df854cbdec7985a7c3eaa1cd6d24b35fabeb |
|
| MD5 | 839f4dc65ae2b3190ee5096d232ba309 |
|
| BLAKE2b-256 | df44c2a4878295bd166ad77317444886bfad781704463d0dd767bd2996d3c03d |
Close
Hashes for sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8caf04db991e10b8a5026f1a602eb6a883e76a09e9619a4d358127735e38fef2 |
|
| MD5 | 0dacff5af21c869d15c86c018e33f6d3 |
|
| BLAKE2b-256 | c2a089909b5d3455ba826b449eb6c9e23230e809cf00bdacc319d6825bfe49cb |
