You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just realized that these three configs (hoverxref_project, hoverxref_version and hoverxref_api_host) are confusing for users, and we should probably add a note that they should not be modified.
People is modifying them because their CI starts failing saying they are not defined and they have fail on warnings enabled. So, defining them makes the CI happy but breaks all the tooltips on RTD.
It may be good to explain this case and suggest the users to define the environment variables READTHEDOCS_PROJECT and READTHEDOCS_VERSION in their CI to avoid it failing in case they are using -W.
I just realized that these three configs (
hoverxref_project
,hoverxref_version
andhoverxref_api_host
) are confusing for users, and we should probably add a note that they should not be modified.https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html#confval-hoverxref_api_host
People is modifying them because their CI starts failing saying they are not defined and they have fail on warnings enabled. So, defining them makes the CI happy but breaks all the tooltips on RTD.
It may be good to explain this case and suggest the users to define the environment variables
READTHEDOCS_PROJECT
andREADTHEDOCS_VERSION
in their CI to avoid it failing in case they are using-W
.Reference: scrapy/scrapy#4480 (comment)
The text was updated successfully, but these errors were encountered: