Skip to content

Sphinx extension that adds a highgly customizable version warning banner

License

Notifications You must be signed in to change notification settings

kastenhq/sphinx-version-warning

 
 

Repository files navigation

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/

About

Sphinx extension that adds a highgly customizable version warning banner

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 57.7%
  • JavaScript 42.3%