GitXplorerGitXplorer
h

sphinx-version-warning

public
16 stars
13 forks
15 issues

Commits

List of commits on branch master.
Unverified
fa6e48eb1dc66f8deea2328ba6f069bf6a808713

Release 1.1.2

hhumitos committed 6 years ago
Verified
673b2dca5e73dc178d59c37ea95ec0f0dc8298a2

Merge pull request #20 from aanm/fix-for-multi-page-document

hhumitos committed 6 years ago
Unverified
a360a9d65fa85577e1aac79b3e05cf07dcee8448

_static: load versionwarning-data.json from any page

aaanm committed 6 years ago
Unverified
ba073e4f835e6c0510f29b349cb977d08fc480b4

Small fixes

hhumitos committed 6 years ago
Unverified
68e7689f2f44d7db5d3d6572d79da355e30b7d25

Examples in the Readme

hhumitos committed 6 years ago
Unverified
cdb1f9703b495975c1f77ebb5a0bfebff49f7031

Release 1.1.1

hhumitos committed 6 years ago

README

The README file for this repository.

|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