From 50959bb3165da87ce6a55da59364db52c48d2da6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0ar=C5=ABnas=20Nejus?= Date: Mon, 2 Feb 2026 03:06:48 +0000 Subject: [PATCH] Fix rendering generated refs This specifically fixes v2.6.0 changelog: diff --git a/before b/after index dc9a2ecd2..51303c65f 100644 --- a/before +++ b/after @@ -51,3 +51,3 @@ Beets now requires Python 3.10 or later since support for EOL Python 3.9 has bee -- Added a reusable requests handler which can be used by plugins to make HTTP requests with built-in retry and backoff logic. It uses beets user-agent and configures timeouts. See `~beetsplug._utils.requests.RequestHandler` for documentation. +- Added a reusable requests handler which can be used by plugins to make HTTP requests with built-in retry and backoff logic. It uses beets user-agent and configures timeouts. See [beetsplug.\_utils.requests.RequestHandler](https://beets.readthedocs.io/en/stable/api/generated/beetsplug._utils.requests.RequestHandler.html#beetsplug._utils.requests.RequestHandler) for documentation. @@ -62,3 +62,3 @@ Beets now requires Python 3.10 or later since support for EOL Python 3.9 has bee - See `~beetsplug._utils.musicbrainz.MusicBrainzAPI` for documentation. + See [beetsplug.\_utils.musicbrainz.MusicBrainzAPI](https://beets.readthedocs.io/en/stable/api/generated/beetsplug._utils.musicbrainz.MusicBrainzAPI.html#beetsplug._utils.musicbrainz.MusicBrainzAPI) for documentation. --- extra/release.py | 2 +- test/test_release.py | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/extra/release.py b/extra/release.py index 0c11415a9..61b4a3a31 100755 --- a/extra/release.py +++ b/extra/release.py @@ -120,7 +120,7 @@ def create_rst_replacements() -> list[Replacement]: # Replace Sphinx directives by documentation URLs, e.g., # :ref:`/plugins/autobpm` -> [AutoBPM Plugin](DOCS/plugins/autobpm.html) ( - r":(?:ref|doc|class|conf):`+(?:([^`<]+)<)?/?([\w.:/_-]+)>?`+", + r":(?:ref|doc|class|conf):`+~?(?:([^`<]+)<)?/?([\w.:/_-]+)>?`+", lambda m: make_ref_link(m[2], m[1]), ), # Convert command references to documentation URLs diff --git a/test/test_release.py b/test/test_release.py index 62b32a714..693aab82a 100644 --- a/test/test_release.py +++ b/test/test_release.py @@ -26,6 +26,8 @@ def rst_changelog(): multi-line change. :bug:`5467` - :ref:`list-cmd` Update. +- |BeetsPlugin| Some plugin change. +- See :class:`~beetsplug._utils.musicbrainz.MusicBrainzAPI` for documentation. You can do something with this command: @@ -77,7 +79,9 @@ Bug fixes: def md_changelog(): return r"""### New features +- See [beetsplug.\_utils.musicbrainz.MusicBrainzAPI](https://beets.readthedocs.io/en/stable/api/generated/beetsplug._utils.musicbrainz.MusicBrainzAPI.html#beetsplug._utils.musicbrainz.MusicBrainzAPI) for documentation. - [Substitute Plugin](https://beets.readthedocs.io/en/stable/plugins/substitute.html): Some substitute multi-line change. :bug: (#5467) +- [beets.plugins.BeetsPlugin](https://beets.readthedocs.io/en/stable/api/generated/beets.plugins.BeetsPlugin.html#beets.plugins.BeetsPlugin) Some plugin change. - [list](https://beets.readthedocs.io/en/stable/reference/cli.html#list-cmd) Update. You can do something with this command: