Add warning banner mentioning that we are in Beta

Author: humitos

README.rst

@@ -5,6 +5,12 @@ sphinx-hoverxref
 
 ``sphinx-hoverxref`` is a Sphinx_ extension to add tooltips on the cross references of the documentation with the content of the linked section.
 
+.. warning::
+
+    This extension is currently in Beta state.
+    This means that there may be some things not well supported or unexpected behavior.
+    If you find any issue, please `report it in the issue tracker <https://github.com/readthedocs/sphinx-hoverxref/issues>`_.
+
 
 Example
 -------

docs/conf.py

@@ -45,6 +45,7 @@
     'sphinx-prompt',
     'autoapi.extension',
     'hoverxref.extension',
+    'versionwarning.extension',
 ]
 
 # Used when building the documentation from the terminal and using a local Read
@@ -69,6 +70,14 @@
 hoverxref_sphinxtabs = True
 hoverxref_mathjax = True
 
+versionwarning_messages = {
+    'latest': 'This extension is currently in Beta state. '
+    'This means that there may be some things not well supported or unexpected behavior. '
+    'If you find any issue, please <a href="https://github.com/readthedocs/sphinx-hoverxref/issues">report it in the issue tracker</a>.'
+}
+versionwarning_banner_title = 'We are in Beta!'
+versionwarning_body_selector = 'div[itemprop="articleBody"]'
+
 autosectionlabel_prefix_document = True
 
 autoapi_dirs = ['../hoverxref']

docs/requirements.txt

@@ -3,3 +3,4 @@ sphinx-autoapi==1.1.0
 sphinx-rtd-theme==0.4.3
 sphinx-tabs==1.1.11
 sphinx-prompt==1.1.0
+sphinx-version-warning==1.1.2