semvec/pypi-packages huggingface dataset:
sphinxext-linkcheckdiff 0.1.0
Sphinx Extension to run diff-only linkchecks
Requires Python: >=3.6

# sphinxext-linkcheckdiff
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

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`

```python
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

```python
linkcheckdiff_branch = "master"
```