modern-sphinx-version-warning
Advanced tools
|PyPI version| |Docs badge| |License|
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.
::
pip install sphinx-version-warning
Add this extension in your conf.py file as:
.. code-block:: python
extensions = [ # ... other extensions here
'versionwarning.extension',
]
Check out the full documentation at https://sphinx-version-warning.readthedocs.io/
.. _SemVer: https://semver.org/
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-version-warning.svg :target: https://pypi.org/project/sphinx-version-warning :alt: Current PyPI version .. |Docs badge| image:: https://readthedocs.org/projects/sphinx-version-warning/badge/?version=latest :target: https://sphinx-version-warning.readthedocs.io/en/latest/?badge=latest :alt: Documentation status .. |License| image:: https://img.shields.io/github/license/humitos/sphinx-version-warning.svg :target: LICENSE :alt: Repository license
FAQs
Sphinx extension to add a warning banner
We found that modern-sphinx-version-warning demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.