Sphinx extension to add a warning banner
Project description
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/
Release history Release notifications | RSS feed
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
File details
Details for the file modern_sphinx_version_warning-1.1.6-py3-none-any.whl.
File metadata
- Download URL: modern_sphinx_version_warning-1.1.6-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 59e7b47e7af929363f7395c1de88f305c09d93bdc2c874d9a654adbd74d788c2 |
|
| MD5 | ba88c7171c0dc83e336b8ea70d5a2680 |
|
| BLAKE2b-256 | 010e6dc4547365b97e28d4936252716de8978d557ef46471b9d971da26e62af2 |
