humitos / sphinx-version-warning

Sphinx extension that adds a highgly customizable version warning banner

Home Page:https://sphinx-version-warning.readthedocs.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

https://sphinx-version-warning.readthedocs.io/

License:MIT License


Languages

Language:Python 57.7%Language:JavaScript 42.3%