Merge branch 'master' into humitos/update-test-suite

Author: humitos

.circleci/config.yml

@@ -8,7 +8,7 @@ commands:
         type: string
       sphinx-version:
         type: string
-        default: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,latest"
+        default: "18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,latest"
     steps:
       - checkout
       - run: pip install --user tox
@@ -50,7 +50,7 @@ jobs:
           version: py310
           # Do not run tests for Python 3.10 and some versions of Sphinx because it's broken
           # See https://github.com/sphinx-doc/sphinx/issues/9816
-          sphinx-version: "18,20,21,22,23,24,42,latest"
+          sphinx-version: "18,20,21,22,23,24,42,43,latest"
 
 workflows:
   version: 2
@@ -61,3 +61,4 @@ workflows:
       - py38
       - py39
       - py310
+

CHANGELOG.rst

@@ -3,6 +3,16 @@ Changelog
 
 This page shows all the changes done on each version.
 
+Version 1.0.0
+-------------
+
+* Official release
+
+Version 0.9b1
+-------------
+
+* Send ``X-HoverXRef-Version`` HTTP header when hitting the API
+
 
 Version 0.8b1
 -------------

README.rst

@@ -21,6 +21,14 @@ Example
 Installation
 ------------
 
+You can install sphinx-hoverxref from PyPI:
+
+::
+
+   pip install sphinx-hoverxref
+
+Or, alternatively, install it from GitHub directly (requires git):
+
 ::
 
    pip install git+https://github.com/readthedocs/sphinx-hoverxref@master

docs/conf.py

@@ -116,14 +116,6 @@
 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

@@ -1,9 +1,9 @@
-sphinx==4.2.0
+sphinx==4.3.1
 sphinx-autoapi==1.8.4
 sphinx-rtd-theme==1.0.0
 sphinx-tabs==3.2.0
 sphinx-prompt==1.4.0
 sphinx-version-warning==1.1.2
-sphinx-notfound-page==0.7.1
+sphinx-notfound-page==0.8
 sphinx-autobuild==2021.3.14
 sphinxcontrib-bibtex==2.4.1

hoverxref/__init__.py

@@ -1 +1 @@
-version = '0.8b1'
+version = '1.0.0'

hoverxref/_static/js/hoverxref.js_t

@@ -93,6 +93,13 @@ function getEmbedURL(url) {
 
 
 $(document).ready(function() {
+    // Define a custom HTTP header to send the requests to the server
+    $.ajaxSetup({
+        beforeSend: function(request) {
+            request.setRequestHeader('X-HoverXRef-Version', '{{ http_hoverxref_version }}');
+        }
+    });
+
     // Remove ``title=`` attribute for intersphinx nodes that have hoverxref enabled.
     // It doesn't make sense the browser shows the default tooltip (browser's built-in)
     // and immediately after that our tooltip was shown.

hoverxref/extension.py

@@ -65,6 +65,8 @@ def copy_asset_files(app, exception):
                 # Then, add the values that the user overrides
                 context[attr] = getattr(app.config, attr)
 
+        context['http_hoverxref_version'] = version
+
         # Finally, add some non-hoverxref extra configs
         configs = ['html_theme']
         for attr in configs:

tests/test_htmltag.py

@@ -3,6 +3,8 @@
 import sphinx
 import textwrap
 
+from hoverxref import version
+
 from .utils import srcdir, prefixdocumentsrcdir, customobjectsrcdir, pythondomainsrcdir, intersphinxsrc, bibtexdomainsrcdir
 
 
@@ -55,6 +57,7 @@ def test_js_render(app, status, warning):
         "var sphinxtabs = false",
         "var mathjax = false",
         "var url = getEmbedURL(href);",
+        f"request.setRequestHeader('X-HoverXRef-Version', '{version}');",
     ]
 
     for chunk in chunks:

tox.ini

@@ -1,8 +1,8 @@
 [tox]
 envlist =
   docs
-  py{36,37,38,39}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,latest}
-  py{310}-sphinx{18,20,21,22,23,24,42,latest}
+  py{36,37,38,39}-sphinx{18,20,21,22,23,24,30,31,32,33,34,35,40,41,42,43,latest}
+  py{310}-sphinx{18,20,21,22,23,24,42,43,latest}
 
 [testenv]
 deps =
@@ -25,7 +25,9 @@ deps =
   sphinx40: sphinx~=4.0.0
   sphinx41: sphinx~=4.1.0
   sphinx42: sphinx~=4.2.0
+  sphinx43: sphinx~=4.3.0
   sphinxlatest: sphinx
+
 commands = pytest {posargs}
 
 # Pin docutils<0.18 for all Python versions using Sphinx 1.x, 2.x, 3.x, 4.0, 4.1
@@ -36,7 +38,7 @@ deps =
   {[testenv]deps}
   docutils<0.18
 
-[testenv:py310-sphinx42]
+[testenv:py310-sphinx43]
 deps =
   {[testenv]deps}
   pytest-cov