Skip to content

Commit 2c22bdc

Browse files
committedFeb 24, 2025
build: Depend on mkdocs-autorefs >= 1.4
1 parent 145954c commit 2c22bdc

File tree

6 files changed

+11
-6
lines changed

6 files changed

+11
-6
lines changed
 

‎config/pytest.ini

+1
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ filterwarnings =
2222
ignore:.*fallback anchor function:DeprecationWarning:mkdocstrings
2323
ignore:.*v1.*`get_options` method:DeprecationWarning:mkdocstrings
2424
ignore:.*`config_file_path` argument:DeprecationWarning:mkdocstrings
25+
ignore:.*from 'mkdocs_autorefs.:DeprecationWarning:mkdocstrings_handlers.python

‎pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ dependencies = [
3434
"Markdown>=3.6",
3535
"MarkupSafe>=1.1",
3636
"mkdocs>=1.4",
37-
"mkdocs-autorefs>=1.3",
37+
"mkdocs-autorefs>=1.4",
3838
"mkdocs-get-deps>=0.2", # TODO: Remove when we depend on mkdocs>=1.5.
3939
"pymdown-extensions>=6.3",
4040
"importlib-metadata>=4.6; python_version < '3.10'",

‎src/mkdocstrings/extension.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
from collections.abc import MutableSequence
4343

4444
from markdown import Markdown
45-
from mkdocs_autorefs.plugin import AutorefsPlugin
45+
from mkdocs_autorefs import AutorefsPlugin
4646

4747

4848
log = get_logger(__name__)

‎src/mkdocstrings/handlers/base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from markdown import Markdown
2121
from markdown.extensions.toc import TocTreeprocessor
2222
from markupsafe import Markup
23-
from mkdocs_autorefs.references import AutorefsInlineProcessor
23+
from mkdocs_autorefs import AutorefsInlineProcessor
2424

2525
# TODO: Replace with `from mkdocs.utils.cache import download_and_cache_url` when we depend on mkdocs>=1.5.
2626
from mkdocs_get_deps.cache import download_and_cache_url
@@ -46,7 +46,7 @@
4646
from collections.abc import Iterable, Iterator, Mapping, Sequence
4747

4848
from markdown import Extension
49-
from mkdocs_autorefs.references import AutorefsHookInterface
49+
from mkdocs_autorefs import AutorefsHookInterface
5050

5151
log = get_logger(__name__)
5252

‎src/mkdocstrings/plugin.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
from mkdocs.config import config_options as opt
2525
from mkdocs.plugins import BasePlugin
2626
from mkdocs.utils import write_file
27-
from mkdocs_autorefs.plugin import AutorefsConfig, AutorefsPlugin
27+
from mkdocs_autorefs import AutorefsConfig, AutorefsPlugin
2828

2929
from mkdocstrings.extension import MkdocstringsExtension
3030
from mkdocstrings.handlers.base import BaseHandler, Handlers

‎tests/test_extension.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,11 @@ def test_register_every_identifier_alias(plugin: MkdocstringsPlugin, ext_markdow
162162
handler.get_anchors = lambda _: ids # type: ignore[union-attr]
163163
handler.get_aliases = lambda _: ids # type: ignore[method-assign]
164164
autorefs = ext_markdown.parser.blockprocessors["mkdocstrings"]._autorefs # type: ignore[attr-defined]
165-
autorefs.current_page = "foo"
165+
166+
class Page:
167+
url = "foo"
168+
169+
autorefs.current_page = Page()
166170
ext_markdown.convert("::: tests.fixtures.headings")
167171
for identifier in ids:
168172
assert identifier in autorefs._secondary_url_map

0 commit comments

Comments
 (0)
Please sign in to comment.