Skip to main content

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
  • delta_inject_location
    • OPTIONAL: Relative location for the toctree to be injected. Defaults to master_doc.

Project details


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)

Uploaded Source

Built Distribution

sphinxext_delta-0.2.0-py3-none-any.whl (4.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page