https://github.com/wpilibsuite/sphinxext-linkcheckdiff

Sphinx extension to run diff-only linkchecks.
https://github.com/wpilibsuite/sphinxext-linkcheckdiff

sphinx-extension

Last synced: about 1 month ago
JSON representation

Sphinx extension to run diff-only linkchecks.

• Host: GitHub
• URL: https://github.com/wpilibsuite/sphinxext-linkcheckdiff
• Owner: wpilibsuite
• License: mit
• Archived: true
• Created: 2020-08-07T14:44:03.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-11-22T04:05:46.000Z (over 3 years ago)
• Last Synced: 2025-04-14T12:06:21.940Z (about 1 month ago)
• Topics: sphinx-extension
• Language: Python
• Homepage:
• Size: 9.77 KB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# sphinxext-linkcheckdiff

![ci](https://github.com/wpilibsuite/sphinxext-linkcheckdiff/workflows/ci/badge.svg)

[![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 sphinxext-linkcheckdiff`

## Requirements

- Sphinx >= 3

## Usage

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

```python

extensions = [

   sphinxext.linkcheckdiff,

]

```

This will add a builder that can be ran using the `make linkcheckdiff` command in your terminal of choice.

## 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 = "origin/main"

```