Sphinx extension for listing changed Sphinx articles
Project description
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
- REQUIRED: Relative path to your articles. IE:
delta_inject_location- OPTIONAL: Relative location for the toctree to be injected. Defaults to
master_doc.
- OPTIONAL: Relative location for the toctree to be injected. Defaults to
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinxext_delta-0.3.1.tar.gz
(4.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxext_delta-0.3.1.tar.gz.
File metadata
- Download URL: sphinxext_delta-0.3.1.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02ce0044144b12f818051ee2545500cfda4e0f8ef4384f4bfa227c85f8b09d2f
|
|
| MD5 |
027af75b38e77357c68b2f24a440cb28
|
|
| BLAKE2b-256 |
e841bef975f9c069041bfb7bda482dc958b083fb0ae1edebbbf8f62d78091290
|
File details
Details for the file sphinxext_delta-0.3.1-py3-none-any.whl.
File metadata
- Download URL: sphinxext_delta-0.3.1-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
23f96cf5013fdb5cdd3edb1325dcca2c8a1e2792b70220a3731f218ca3bd253e
|
|
| MD5 |
40aea52b775eacc209c46beda419bf91
|
|
| BLAKE2b-256 |
a4c3bab0340d377392e8631d22269ed177823ec24b96df08907c64fea7123b8a
|
