Rename hoverxref_tooltip_api_host to hoverxref_api_host

This config works for both, tooltip and modal now. So, the "tooltip"
prefix is not needed anymore.

I added a warning message and also keep support for the old name.

Author: humitos

docs/conf.py

@@ -51,14 +51,14 @@
 
 # Used when building the documentation from the terminal and using a local Read
 # the Docs instance as backend
-hoverxref_tooltip_api_host = 'http://localhost:8000'
+hoverxref_api_host = 'http://localhost:8000'
 
 if os.environ.get('READTHEDOCS') == 'True':
     # Building on Read the Docs
-    hoverxref_tooltip_api_host = 'https://readthedocs.org'
+    hoverxref_api_host = 'https://readthedocs.org'
 if os.environ.get('LOCAL_READTHEDOCS') == 'True':
     # Building on a local Read the Docs instance
-    hoverxref_tooltip_api_host = 'http://community.dev.readthedocs.io'
+    hoverxref_api_host = 'http://community.dev.readthedocs.io'
 
 hoverxref_tooltip_maxwidth = 650
 hoverxref_auto_ref = True

docs/configuration.rst

@@ -88,19 +88,19 @@ These settings are global and have effect on both, tooltips and modal dialogues.
 
 .. _Mathjax: http://www.sphinx-doc.org/es/master/usage/extensions/math.html#module-sphinx.ext.mathjax
 
+.. confval:: hoverxref_api_host
 
-Tooltipster
------------
+   Description: Host URL for the API to retrieve the content of the floating window
 
-These settings have effect only in tooltips.
+   Default: ``https://readthedocs.org``
 
-.. confval:: hoverxref_tooltip_api_host
+   Type: string
 
-   Description: Host URL for the API to retrieve the tooltip content
 
-   Default: ``https://readthedocs.org``
+Tooltipster
+-----------
 
-   Type: string
+These settings have effect only in tooltips.
 
 .. confval:: hoverxref_tooltip_class
 

docs/development.rst

@@ -23,7 +23,7 @@ To setup this approach, you need to put these settings in the ``conf.py`` of you
 
    hoverxref_project = 'sphinx-hoverxref'
    hoverxref_version = 'latest'
-   hoverxref_tooltip_api_host = 'https://readthedocs.org'
+   hoverxref_api_host = 'https://readthedocs.org'
 
 After building the documentation all the requests will be done to URLs like::
 
@@ -84,7 +84,7 @@ To make the extension to work, you will need to define this setting in your ``co
 
 .. code-block:: python
 
-   hoverxref_tooltip_api_host = 'http://dev.readthedocs.io:8000'
+   hoverxref_api_host = 'http://dev.readthedocs.io:8000'
 
 .. tip::
 

hoverxref/_static/js/hoverxref.js_t

@@ -79,7 +79,7 @@ $(document).ready(function() {
             // 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_api_host }}' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&section=' + section;
                 $.get(url, function(data) {
                     // call the 'content' method to update the content of our tooltip with the returned data.
                     // note: this content update will trigger an update animation (see the updateAnimation option)
@@ -150,7 +150,7 @@ $(document).ready(function() {
         var doc = element.data('doc');
         var section = element.data('section');
         console.debug('Data: project=' + project + ' version=' + version + ' doc=' + doc + ' section=' + section);
-        var url = '{{ hoverxref_tooltip_api_host }}' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&section=' + section;
+        var url = '{{ hoverxref_api_host }}' + '/api/v2/embed/?' + 'project=' + project + '&version=' + version + '&doc=' + doc + '&section=' + section;
 
         $.get(url, function(data) {
             var content = $('<div></div>');

hoverxref/extension.py

@@ -3,11 +3,15 @@
 from docutils import nodes
 from sphinx.roles import XRefRole
 from sphinx.util.fileutil import copy_asset
+from sphinx.util import logging
 
 from . import version
 from .domains import HoverXRefPythonDomain, HoverXRefStandardDomain
 from .translators import HoverXRefHTMLTranslator
 
+logger = logging.getLogger(__name__)
+
+
 HOVERXREF_ASSETS_FILES = [
     'js/hoverxref.js_t',  # ``_t`` tells Sphinx this is a template
 ]
@@ -132,6 +136,15 @@ def setup_theme(app, exception):
         )
 
 
+def deprecated_configs_warning(app, exception):
+    """Log warning message if old configs are used."""
+    default, rebuild, types = app.config.values.get('hoverxref_tooltip_api_host')
+    if app.config.hoverxref_tooltip_api_host != default:
+        message = '"hoverxref_tooltip_api_host" is deprecated and replaced by "hoverxref_api_host".'
+        logger.warning(message)
+        app.config.hoverxref_api_host = app.config.hoverxref_tooltip_api_host
+
+
 def setup(app):
     """Setup ``hoverxref`` Sphinx extension."""
 
@@ -148,8 +161,10 @@ def setup(app):
     app.add_config_value('hoverxref_roles', [], 'env')
     app.add_config_value('hoverxref_domains', [], 'env')
     app.add_config_value('hoverxref_type', 'tooltip', 'env')
+    app.add_config_value('hoverxref_api_host', 'https://readthedocs.org', 'env')
 
     # Tooltipster settings
+    # Deprecated in favor of ``hoverxref_api_host``
     app.add_config_value('hoverxref_tooltip_api_host', 'https://readthedocs.org', 'env')
     app.add_config_value('hoverxref_tooltip_theme', ['tooltipster-shadow', 'tooltipster-shadow-custom'], 'env')
     app.add_config_value('hoverxref_tooltip_interactive', True, 'env')
@@ -180,6 +195,8 @@ def setup(app):
     app.set_translator('readthedocs', HoverXRefHTMLTranslator, override=True)
     app.set_translator('readthedocsdirhtml', HoverXRefHTMLTranslator, override=True)
 
+    app.connect('config-inited', deprecated_configs_warning)
+
     app.connect('config-inited', setup_domains)
     app.connect('config-inited', setup_sphinx_tabs)
     app.connect('config-inited', setup_theme)