https://github.com/humitos/sphinx-version-warning

Sphinx extension that adds a highgly customizable version warning banner
https://github.com/humitos/sphinx-version-warning

banner documentation python readthedocs sphinx warning

Last synced: 11 days ago
JSON representation

Sphinx extension that adds a highgly customizable version warning banner

• Host: GitHub
• URL: https://github.com/humitos/sphinx-version-warning
• Owner: humitos
• License: mit
• Created: 2018-05-23T00:01:06.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T23:48:49.000Z (over 2 years ago)
• Last Synced: 2025-06-02T08:45:52.269Z (26 days ago)
• Topics: banner, documentation, python, readthedocs, sphinx, warning
• Language: Python
• Homepage: https://sphinx-version-warning.readthedocs.io/
• Size: 284 KB
• Stars: 15
• Watchers: 3
• Forks: 13
• Open Issues: 15
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
|PyPI version| |Docs badge| |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:

.. code-block:: python

   extensions = [

    # ... other extensions here

    'versionwarning.extension',

   ]

Documentation

-------------

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