sphinx-hoverxref icon indicating copy to clipboard operation
sphinx-hoverxref copied to clipboard

DeprecationWarning with Sphinx v8.0.2

Open Zac-HD opened this issue 1 year ago • 1 comments

.../python3.10/site-packages/hoverxref/extension.py:312: RemovedInSphinx90Warning: The '_Opt' object tuple interface is deprecated, use attribute access instead for 'default', 'rebuild', and 'valid_types'.
  default, rebuild, types = app.config.values.get('hoverxref_tooltip_api_host')
.../python3.10/site-packages/hoverxref/extension.py:280: RemovedInSphinx90Warning: The '_Opt' object tuple interface is deprecated, use attribute access instead for 'default', 'rebuild', and 'valid_types'.
  default, rebuild, types = app.config.values.get('hoverxref_modal_class')
.../python3.10/site-packages/hoverxref/extension.py:67: RemovedInSphinx90Warning: The '_Opt' object tuple interface is deprecated, use attribute access instead for 'default', 'rebuild', and 'valid_types'.
  context[attr] = app.config.values[attr][0]

found via this CI run on https://github.com/HypothesisWorks/hypothesis/pull/4129, where we continue to be very happy that hoverxref exists 💖

Zac-HD avatar Oct 08 '24 01:10 Zac-HD

Hi 👋🏼 . Would you like to provide a PR? It shouldn't be too hard.

We did a similar work in https://github.com/readthedocs/sphinx-notfound-page/pull/236/ for another extension we maintain. Note that we have to check for Sphinx 7.3, tho, since we fixed that in a later PR at https://github.com/readthedocs/sphinx-notfound-page/pull/241

humitos avatar Oct 08 '24 09:10 humitos

Hi Manuel, I've opened #313 to fix this issue 🙂

Thanks for all your work on readthedocs!

Zac-HD avatar Nov 13 '24 18:11 Zac-HD

Would it be possible to push a small patch release with this fix? :)

jakkdl avatar Apr 03 '25 08:04 jakkdl

@jakkdl this extension is deprecated now since the feature was introduced in Read the Docs application itself. It's now called links preview: https://docs.readthedocs.com/platform/stable/link-previews.html

humitos avatar Apr 03 '25 14:04 humitos

@jakkdl this extension is deprecated now since the feature was introduced in Read the Docs application itself. It's now called links preview: https://docs.readthedocs.com/platform/stable/link-previews.html

Should a warning be added to the readme in this repo, as well as a link to those docs and/or https://github.com/readthedocs/addons?

edgarrmondragon avatar Apr 03 '25 18:04 edgarrmondragon

Should a warning be added to the readme in this repo, as well as a link to those docs and/or readthedocs/addons?

Yes. I just haven't had the time to do it. Would you want to open a PR with this?

humitos avatar Apr 07 '25 14:04 humitos

Should a warning be added to the readme in this repo, as well as a link to those docs and/or readthedocs/addons?

Yes. I just haven't had the time to do it. Would you want to open a PR with this?

I've put together a PR to mark the extension as deprecated: https://github.com/readthedocs/sphinx-hoverxref/pull/337

agriyakhetarpal avatar Apr 09 '25 07:04 agriyakhetarpal