Send docpath with the full filename path (/section/filename.html)

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

@@ -13,7 +13,7 @@ def _is_hoverxref_configured(self, env):
         version = env.config.hoverxref_version
         return project and version
 
-    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
@@ -22,9 +22,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
+
 
 class HoverXRefPythonDomain(HoverXRefBaseDomain, PythonDomain):
 
@@ -42,7 +48,9 @@ def resolve_xref(self, env, fromdocname, builder, type, target, node, contnode):
 
         if self._is_hoverxref_configured(env):
             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,
@@ -83,7 +91,9 @@ def _resolve_ref_xref(self, env, fromdocname, builder, typ, target, node, contno
 
         if self._is_hoverxref_configured(env) and (env.config.hoverxref_auto_ref or typ == 'hoverxref'):
             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,
@@ -99,7 +109,9 @@ def _resolve_obj_xref(self, env, fromdocname, builder, typ, target, node, contno
         if typ in env.config.hoverxref_roles:
             docname, labelid = get_ref_obj_data(self, node, typ, target)
             if self._is_hoverxref_configured(env):
-                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,