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 files for sphinxext-linkcheckdiff 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxext-linkcheckdiff-0.1.0.tar.gz | 2.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.0 kB
Release files / sphinxext-linkcheckdiff-0.1.0.tar.gz
| Download URL | sphinxext-linkcheckdiff-0.1.0.tar.gz |
|---|---|
| Size | 2.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c134d21efafa6a21e209e8181d58df854cbdec7985a7c3eaa1cd6d24b35fabeb
|
|
BLAKE2b-256 checksum How to use checksums |
df44c2a4878295bd166ad77317444886bfad781704463d0dd767bd2996d3c03d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl
| Download URL | sphinxext_linkcheckdiff-0.1.0-py3-none-any.whl |
|---|---|
| Size | 3.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8caf04db991e10b8a5026f1a602eb6a883e76a09e9619a4d358127735e38fef2
|
|
BLAKE2b-256 checksum How to use checksums |
c2a089909b5d3455ba826b449eb6c9e23230e809cf00bdacc319d6825bfe49cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
