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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxext-linkcheckdiff-0.1.0.tar.gz.
File metadata
- Download URL: sphinxext-linkcheckdiff-0.1.0.tar.gz
- Upload date:
- Size: 2.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c134d21efafa6a21e209e8181d58df854cbdec7985a7c3eaa1cd6d24b35fabeb
|
|
| MD5 |
839f4dc65ae2b3190ee5096d232ba309
|
|
| BLAKE2b-256 |
df44c2a4878295bd166ad77317444886bfad781704463d0dd767bd2996d3c03d
|
File details
Details for the file sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl
- Upload date:
- Size: 3.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8caf04db991e10b8a5026f1a602eb6a883e76a09e9619a4d358127735e38fef2
|
|
| MD5 |
0dacff5af21c869d15c86c018e33f6d3
|
|
| BLAKE2b-256 |
c2a089909b5d3455ba826b449eb6c9e23230e809cf00bdacc319d6825bfe49cb
|
