Merge branch 'master' of github.com:humitos/sphinx-hoverxref into humitos/ignore-refs

Author: humitos

hoverxref/_static/js/hoverxref.js_t

@@ -39,14 +39,15 @@ $(document).ready(function() {
             var project = $origin.data('project');
             var version = $origin.data('version');
             var doc = $origin.data('doc');
+            var docpath = $origin.data('docpath');
             var section = $origin.data('section');
 
-            console.debug('Data: project=' + project + ' version=' + version + ' doc=' + doc + ' section=' + section);
+            console.debug('Data: project=' + project + ' version=' + version + ' doc=' + doc + ' path=' + docpath + ' section=' + section);
 
             // we set a variable so the data is only loaded once via Ajax, not every time the tooltip opens
             if ($origin.data('loaded') !== true) {
                 // TODO: improve URL handling here
-                var url = '{{ hoverxref_tooltip_api_host }}' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&section=' + section;
+                var url = '{{ hoverxref_tooltip_api_host }}' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&path=' + docpath + '&section=' + section;
                 $.get(url, function(data) {
 
                     // call the 'content' method to update the content of our tooltip with the returned data.

hoverxref/domains.py

@@ -6,7 +6,7 @@
 
 class HoverXRefBaseDomain:
 
-    def _inject_hoverxref_data(self, env, refnode, docname, labelid):
+    def _inject_hoverxref_data(self, env, refnode, docname, docpath, labelid):
         refnode.replace_attr('classes', ['hoverxref'])
 
         project = env.config.hoverxref_project
@@ -15,9 +15,15 @@ def _inject_hoverxref_data(self, env, refnode, docname, labelid):
             'data-project': project,
             'data-version': version,
             'data-doc': docname,
+            'data-docpath': docpath,
             'data-section': labelid,
         }
 
+    def _get_docpath(self, builder, docname):
+        docpath = builder.get_outfilename(docname)
+        docpath = docpath.replace(builder.outdir, '')
+        return docpath
+
     def _is_ignored_ref(self, env, target):
         if target in env.config.hoverxref_ignore_refs:
             logger.info(
@@ -49,7 +55,8 @@ def resolve_xref(self, env, fromdocname, builder, type, target, node, contnode):
         name, obj = matches[0]
 
         docname, labelid = obj[0], name
-        self._inject_hoverxref_data(env, refnode, docname, labelid)
+        docpath = self._get_docpath(builder, docname)
+        self._inject_hoverxref_data(env, refnode, docname, docpath, labelid)
         logger.info(
             ':ref: _hoverxref injected: fromdocname=%s %s',
             fromdocname,
@@ -90,8 +97,10 @@ def _resolve_ref_xref(self, env, fromdocname, builder, typ, target, node, contno
         ]):
             return refnode
 
+
         docname, labelid, _ = get_ref_xref_data(self, node, target)
-        self._inject_hoverxref_data(env, refnode, docname, labelid)
+        docpath = self._get_docpath(builder, docname)
+        self._inject_hoverxref_data(env, refnode, docname, docpath, labelid)
         logger.info(
             ':ref: _hoverxref injected: fromdocname=%s %s',
             fromdocname,
@@ -112,7 +121,8 @@ def _resolve_obj_xref(self, env, fromdocname, builder, typ, target, node, contno
             return refnode
 
         docname, labelid = get_ref_obj_data(self, node, typ, target)
-        self._inject_hoverxref_data(env, refnode, docname, labelid)
+        docpath = self._get_docpath(builder, docname)
+        self._inject_hoverxref_data(env, refnode, docname, docpath, labelid)
         logger.info(
             ':%s: _hoverxref injected: fromdocname=%s %s',
             typ,

tests/test_htmltag.py

@@ -74,7 +74,7 @@ def test_project_version_settings(app, status, warning):
 
     chunks = [
         '<a class="reference internal" href="chapter-i.html#chapter-i"><span class="std std-ref">This a :ref: to Chapter I</span></a>',
-        '<a class="hoverxref reference internal" data-doc="chapter-i" data-project="myproject" data-section="section-i" data-version="myversion" href="chapter-i.html#section-i"><span class="std std-ref">This a :hoverxref: to Chapter I, Section I</span></a>',
+        '<a class="hoverxref reference internal" data-doc="chapter-i" data-docpath="/chapter-i.html" data-project="myproject" data-section="section-i" data-version="myversion" href="chapter-i.html#section-i"><span class="std std-ref">This a :hoverxref: to Chapter I, Section I</span></a>',
     ]
 
     for chunk in chunks:
@@ -101,7 +101,7 @@ def test_js_render(app, status, warning):
         "animation: 'fade'",
         "animationDuration: 0",
         "content: 'Loading...'",
-        "var url = 'https://readthedocs.org' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&section=' + section;",
+        "var url = 'https://readthedocs.org' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&path=' + docpath + '&section=' + section;",
     ]
 
     for chunk in chunks:
@@ -123,7 +123,7 @@ def test_autosectionlabel_project_version_settings(app, status, warning):
 
     chunks = [
         '<a class="reference internal" href="chapter-i.html#chapter-i"><span class="std std-ref">This a :ref: to Chapter I</span></a>.',
-        '<a class="hoverxref reference internal" data-doc="chapter-i" data-project="myproject" data-section="chapter-i" data-version="myversion" href="chapter-i.html#chapter-i"><span class="std std-ref">This a :hoverxref: to Chapter I</span></a>',
+        '<a class="hoverxref reference internal" data-doc="chapter-i" data-docpath="/chapter-i.html" data-project="myproject" data-section="chapter-i" data-version="myversion" href="chapter-i.html#chapter-i"><span class="std std-ref">This a :hoverxref: to Chapter I</span></a>',
     ]
 
     for chunk in chunks:
@@ -141,8 +141,8 @@ def test_custom_object(app, status, warning):
     content = open(path).read()
 
     chunks = [
-        '<a class="hoverxref reference internal" data-doc="configuration" data-project="myproject" data-section="confval-conf-title" data-version="myversion" href="configuration.html#confval-conf-title"><code class="xref std std-confval docutils literal notranslate"><span class="pre">This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">:confval:</span> <span class="pre">to</span> <span class="pre">conf-title</span></code></a>',
-        '<a class="hoverxref reference internal" data-doc="configuration" data-project="myproject" data-section="configuration" data-version="myversion" href="configuration.html#configuration"><span class="std std-ref">This is a :hoverxref: to Configuration document</span></a>',
+        '<a class="hoverxref reference internal" data-doc="configuration" data-docpath="/configuration.html" data-project="myproject" data-section="confval-conf-title" data-version="myversion" href="configuration.html#confval-conf-title"><code class="xref std std-confval docutils literal notranslate"><span class="pre">This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">:confval:</span> <span class="pre">to</span> <span class="pre">conf-title</span></code></a>',
+        '<a class="hoverxref reference internal" data-doc="configuration" data-docpath="/configuration.html" data-project="myproject" data-section="configuration" data-version="myversion" href="configuration.html#configuration"><span class="std std-ref">This is a :hoverxref: to Configuration document</span></a>',
     ]
 
     for chunk in chunks:
@@ -162,9 +162,9 @@ def test_python_domain(app, status, warning):
     content = open(path).read()
 
     chunks = [
-        '<a class="hoverxref reference internal" data-doc="api" data-project="myproject" data-section="hoverxref.extension.HoverXRefStandardDomainMixin" data-version="myversion" href="api.html#hoverxref.extension.HoverXRefStandardDomainMixin" title="hoverxref.extension.HoverXRefStandardDomainMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">:py:class:</span> <span class="pre">role</span> <span class="pre">to</span> <span class="pre">a</span> <span class="pre">Python</span> <span class="pre">object</span></code></a>',
-        '<a class="hoverxref reference internal" data-doc="api" data-project="myproject" data-section="hoverxref.extension" data-version="myversion" href="api.html#module-hoverxref.extension" title="hoverxref.extension"><code class="xref py py-mod docutils literal notranslate"><span class="pre">hoverxref.extension</span></code></a>',
-        '<a class="hoverxref reference internal" data-doc="api" data-project="myproject" data-section="hoverxref.utils.get_ref_xref_data" data-version="myversion" href="api.html#hoverxref.utils.get_ref_xref_data" title="hoverxref.utils.get_ref_xref_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">hoverxref.utils.get_ref_xref_data()</span></code></a>',
+        '<a class="hoverxref reference internal" data-doc="api" data-docpath="/api.html" data-project="myproject" data-section="hoverxref.extension.HoverXRefStandardDomainMixin" data-version="myversion" href="api.html#hoverxref.extension.HoverXRefStandardDomainMixin" title="hoverxref.extension.HoverXRefStandardDomainMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">:py:class:</span> <span class="pre">role</span> <span class="pre">to</span> <span class="pre">a</span> <span class="pre">Python</span> <span class="pre">object</span></code></a>',
+        '<a class="hoverxref reference internal" data-doc="api" data-docpath="/api.html" data-project="myproject" data-section="hoverxref.extension" data-version="myversion" href="api.html#module-hoverxref.extension" title="hoverxref.extension"><code class="xref py py-mod docutils literal notranslate"><span class="pre">hoverxref.extension</span></code></a>',
+        '<a class="hoverxref reference internal" data-doc="api" data-docpath="/api.html" data-project="myproject" data-section="hoverxref.utils.get_ref_xref_data" data-version="myversion" href="api.html#hoverxref.utils.get_ref_xref_data" title="hoverxref.utils.get_ref_xref_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">hoverxref.utils.get_ref_xref_data()</span></code></a>',
     ]
 
     for chunk in chunks: