Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Update compatibility of setup_intersphinx module name check with Sphinx-7.4 #302

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions hoverxref/extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,7 @@ def setup_intersphinx(app, config):
return

for listener in app.events.listeners.get('missing-reference'):
module_name = inspect.getmodule(listener.handler).__name__
if module_name == 'sphinx.ext.intersphinx':
if listener.handler == sphinx_missing_reference:
app.disconnect(listener.id)


Expand Down
27 changes: 24 additions & 3 deletions tests/test_internals.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import inspect
import os
import pytest
import shutil
from unittest import mock

from sphinx.events import EventListener
from sphinx.ext.intersphinx import missing_reference as intersphinx_missing_reference
from hoverxref.extension import missing_reference

from .utils import srcdir


Expand Down Expand Up @@ -34,3 +35,23 @@ def _get_docpath(self, builder, docname):
content = open(path).read()

assert app.builder.format == 'latex'


@pytest.mark.sphinx(
srcdir=srcdir,
confoverrides={
'hoverxref_domains': ['py'],
'hoverxref_intersphinx': ['python'],
'hoverxref_auto_ref': True,
'extensions': [
'sphinx.ext.intersphinx',
'hoverxref.extension',
],
},
)
def test_disconnect_intersphinx_listener(app, status, warning):
"""The ``missing-reference`` listener from ``sphinx.ext.intershinx`` should be dropped in favor of ours."""
app.build()
missing_reference_listeners = app.events.listeners['missing-reference']
assert EventListener(id=mock.ANY, priority=mock.ANY, handler=intersphinx_missing_reference) not in missing_reference_listeners
assert EventListener(id=mock.ANY, priority=mock.ANY, handler=missing_reference) in missing_reference_listeners
3 changes: 2 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ isolated_build = True

envlist =
docs
py{38,39,310,312}-sphinx{50,53,60,62,70,73,latest}
py{38,39,310,312}-sphinx{50,53,60,62,70,73,74,latest}

[testenv]
deps =
Expand All @@ -18,6 +18,7 @@ deps =
sphinx62: sphinx~=6.2.0
sphinx70: sphinx~=7.0.0
sphinx73: sphinx[test]~=7.3.0
sphinx74: sphinx[test]~=7.4.0
sphinxlatest: sphinx[test]

commands = pytest {posargs}
Expand Down