Skip to main content

Sphinx extension to add a warning banner

Project description

Current PyPI version Documentation status Repository license

sphinx-version-warning

sphinx-version-warning is a Sphinx extension that allows you to show a Warning banner at the top of your documentation. By default, the banner is shown based on the version that is displayed compared (using SemVer) with the latest version on the server.

Installation

pip install sphinx-version-warning

Configuration

Add this extension in your conf.py file as:

extensions = [
 # ... other extensions here

 'versionwarning.extension',
]

Documentation

Check out the full documentation at https://sphinx-version-warning.readthedocs.io/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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