Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.26 KB

README.rst

File metadata and controls

48 lines (30 loc) · 1.26 KB

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/