readthedocs / sphinx-hoverxref

Sphinx extension to show tooltips with content embedded when hover a reference.
https://sphinx-hoverxref.readthedocs.io/
MIT License
96 stars 40 forks source link

Tooltip Content Not Generating with Read the Docs #285

Open levseyd01 opened 5 months ago

levseyd01 commented 5 months ago

Hello, I have been trying to get this to work for a few hours now, but I have not been able to come up with a solution.

I am using Read the Docs, specifically the Basic Business Plan, and the Sphinx Book HTML theme.

I read through an issue you all were having with Jupyter Notebook, but it seems to have been resolved. I am using the latest version of hoverxref.

I have tried the following:

Are there any other requirements, beyond what's listed in the documentation, that need to be considered to get hoverxref to work with the Sphinx Book theme or any other theme? (I also tried it with sphinx_rtd_theme, but it did not work).

Do I need to configure the readthedocs.yml file in a certain way?

humitos commented 5 months ago

Hi, thanks for opening this issue.

I am using Read the Docs, specifically the Basic Business Plan, and the Sphinx Book HTML theme.

Is your project publicly available? What's the documentation URL?

Adding hoverxref_api_host = 'readthedocs.org' to conf.py file,

Since you are using Read the Docs for Business, you should either leave this setting undefined so it's auto-configured itself. The default value should work for your use case.

Do I need to configure the readthedocs.yml file in a certain way?

No. This file does not affect to the configuration of this Sphinx extension.