Sphinx extension to generate a page of changed articles on ReadTheDocs.
python -m pip install sphinxext-delta
- Sphinx >= 2
- ReadTheDocs
- GitHub
No other environments are supported.
Add sphinxext.delta to your extensions list in your conf.py
extensions = [
sphinxext.delta,
]
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