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
Project details
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.2.0.tar.gz
(3.0 kB
view hashes)
Built Distribution
Close
Hashes for sphinxext_delta-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca9df9cb96ec8854a115eeedc348e5645a87daed1b672eb916d11a10a77b7383 |
|
MD5 | caf2481981f449938774536334c9f907 |
|
BLAKE2b-256 | e032b1448ae0d45281a8edb719958617f418e465456e9e98e2e3c0a98172c7cd |