Default hoverxref_api_host to the proxied API

[stsewd]

This also doesn't require .com users changing anything to use the extension.

[ericholscher]

I think we only want to default this value when running on RTD, don't we? For dev setup this will cause weird breakage for a lot of users.

[stsewd]

It's documented that this should be changed to rtd.org in the dev docs, for the docs of this extension we are checking if we are running on rtd

sphinx-hoverxref/docs/conf.py

Lines 66 to 68 in f6e533f

	# Used when building the documentation locally.
	if os.environ.get('READTHEDOCS') != 'True':
	hoverxref_api_host = 'https://readthedocs.org'

People testing this locally will need to define the hoverxref_project and hoverxref_version anyway.

[humitos]

It would be good to update this PR. I think we need:

• default host to readthedocs.org
• change the host to _/ if running on Read the Docs and the host was not manually defined by the user
• remove mentions to hoverxref_project and hoverxref_version since they are not needed anymore

[ericholscher]

Bumping this, since I had a customer just run into this. Would be good to enable this.

[stsewd]

Changed to just default to /_ for the API host. Looks like the current implementation just sends the current URL to the API, so doesn't look like there is an easy way to test the extension locally.

[ericholscher]

I think this change makes sense, but also want to make sure we have a plan moving forward w/ hoverxref support in readthedocs-client. So leaving the review to @humitos to coordinate.

[humitos]

want to make sure we have a plan moving forward w/ hoverxref support in readthedocs-client.

My plan is that hoverxref/tooltips re-implemented there ¹ and this extension won't be needed anymore in the future. In my opinion, we should eventually deprecate this Sphinx extension and archive the repository.

However, we could keep this extension if we want to have full control of where (on what Sphinx roles) to show tooltips -- which is the complex part of this extension and something you never liked too much since you want tooltips everywhere 😄 . Anyways, something to consider when talking about the user's API in readthedocs/addons#13

Footnotes

1. in fact that work is already done --there is some CSS style things missing and lot of conversations, tho 😄 ↩

[stsewd]

We should do a new release with this change