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 >= 2
- 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
Release history Release notifications | RSS feed
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.1.0.tar.gz
(2.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinxext_delta-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fb25bc22631e824d72d3e8cc636e83e91e3975938781f0f5a2eb6df121a18330 |
|
| MD5 | b24333a9c219135d8f437efa4e13e8f7 |
|
| BLAKE2b-256 | f1dda81307e7c2139a6c5b45c57e9ff7405f1729beefa8d2472c0aed21297b2a |
