readthedocs / sphinx-hoverxref

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

Content not loading #224

Open brendan-mcauliffe opened 1 year ago

brendan-mcauliffe commented 1 year ago

Hi all,

I am trying to get hoverxref to work for the last number of days and to no avail. I am working on some documentation, which is being built and hosted on readthedocs.com.

My issue is that the content is not loading, the window appears and the reference to each section works, but no content gets displayed.

I am using the following command in .rst: This is implemented in the :hoverxref:`class_of_interest<hoverxref:class_of_interest>` class.

I am using another library, Breathe, to link Doxygen for a C++ based applicaton to RTD. The section of documentation outlining this class is referenced as follows: .. _hoverxref:class_of_interest:

In my config file I have the following set-up for hoverxref:

extensions = ['sphinxcontrib.seqdiag','sphinxcontrib.blockdiag', 'sphinx_copybutton', 'hoverxref.extension', 'breathe',]

...

hoverxref_auto_ref = True

hoverxref_role_types = {
    'hoverxref' : 'tooltip',
    'ref' : 'tooltip',
}

You will see that I am setting the :ref: command to use hoverxref.

Finally, in my requirements I have the following:

sphinx==4.0.2
sphinx-rtd-theme==1.0.0 
sphinxcontrib-seqdiag==2.0.0
sphinxcontrib-blockdiag==2.0.0
sphinx-autobuild==2021.3.14
docutils==0.17.1
funcparserlib==1.0.0a0
sphinx-toolbox
sphinx-copybutton
sphinx-hoverxref
breathe

Any guidance would be greatly appreciated, this issue is leading to a roadblock in the progression of the document I am writing.

To clarify, I am seeing this issue both when I build and test locally, and when I build and test on the RTD hosted build.

humitos commented 1 year ago

Hi! Thanks for opening this issue. At first sight, I don't see anything wrong in your configuration. Is your project public? If not, can you create a small public project and host it on Read the Docs for Business (readthedocs.com) where I can reproduce this issue and explore with it (forking the repository if required)?

brendan-mcauliffe commented 1 year ago

Hi, so I have created a public branch here: https://docs.srsran.com/en/hoverxref_test/general/source/5_devguide_test.html

It seems to be working fine now. Although it seems strange that when I built it on readthedocs.com and viewed the build it did not show any content in the tooltip.

Is there a way to configure this so that I can avoid having to create a live build each time?

humitos commented 1 year ago

It seems to be working fine now. Although it seems strange that when I built it on readthedocs.com and viewed the build it did not show any content in the tooltip.

Maybe it was a cache issue?

Is there a way to configure this so that I can avoid having to create a live build each time?

This is not currently possible in an easy way. Take a look at #112. BTW, are you using the Pull Request Builder (https://docs.readthedocs.io/en/latest/pull-requests.html)?