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 is 1 required and 1 optional configuration:
delta_doc_path- REQUIRED: Relative path to your articles. IE:
source/docs
- REQUIRED: Relative path to your articles. IE:
delta_inject_location- OPTIONAL: Relative location for the toctree to be injected. Defaults to
index.rst.
- OPTIONAL: Relative location for the toctree to be injected. Defaults to
1 maintainer
Metadata
1 maintainer
Release files for sphinxext-delta 0.4.1
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_delta-0.4.1.tar.gz | 4.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxext_delta-0.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.4 kB
Release files / sphinxext_delta-0.4.1.tar.gz
| Download URL | sphinxext_delta-0.4.1.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a2c377c7459f83510acdd96d687ed9e0fb01bc873f30f4d4db1471e61cdaffe
|
|
BLAKE2b-256 checksum How to use checksums |
87acf754400a815c80af51852086d114ed4603f4e31a00a35eff19a6d6ffd648
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / sphinxext_delta-0.4.1-py3-none-any.whl
| Download URL | sphinxext_delta-0.4.1-py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
edd12e1c9036e6bd59c42e91c34884d4d3cbaa28e4bc5beb170820e5f1b56614
|
|
BLAKE2b-256 checksum How to use checksums |
1162f2579bc3b573fca607c850269f9a798e50b9e7809aae3fa7d47119149887
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
