Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tooltip Content Not Generating with Read the Docs #285

Open
levseyd01 opened this issue Mar 12, 2024 · 1 comment
Open

Tooltip Content Not Generating with Read the Docs #285

levseyd01 opened this issue Mar 12, 2024 · 1 comment
Labels
Needed: documentation Documentation is required

Comments

@levseyd01
Copy link

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:

  • Disabling all other extensions,
  • Changing themes to sphinx_rtd_theme,
  • Removing everything except the extension,
  • Changing the default behavior,
  • Adding hoverxref_api_host = 'https://readthedocs.org' to conf.py file,
  • And more.

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
Copy link
Member

humitos commented Mar 13, 2024

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.

@humitos humitos added the Needed: documentation Documentation is required label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

2 participants