https://github.com/wpilibsuite/sphinxext-delta
Sphinx extension for previewing changed github articles
https://github.com/wpilibsuite/sphinxext-delta
hacktoberfest sphinx-extension
Last synced: about 1 month ago
JSON representation
Sphinx extension for previewing changed github articles
- Host: GitHub
- URL: https://github.com/wpilibsuite/sphinxext-delta
- Owner: wpilibsuite
- License: other
- Created: 2021-04-01T03:02:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T22:45:15.000Z (4 months ago)
- Last Synced: 2025-04-14T12:05:15.081Z (about 1 month ago)
- Topics: hacktoberfest, sphinx-extension
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 2
- Watchers: 7
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sphinxext-delta
Sphinx extension to generate a page of changed articles on ReadTheDocs.
## Installation
```
python -m pip install sphinxext-delta
```
## Requirements
- Sphinx >= 5
- ReadTheDocs
- GitHub
No other environments are supported.
## Usage
Add `sphinxext.delta` to your extensions list in your `conf.py`
```
extensions = [
sphinxext.delta,
]
```
## Options
There are 2 required and 1 optional configurations:
- `delta_doc_path`
- REQUIRED: Relative path to your articles. IE: `source/docs`
- `delta_inject_location`
- OPTIONAL: Relative location for the toctree to be injected. Defaults to `master_doc`.