Update release notes.

Add an extension to link to GitHub user profiles directly from
the documentation.

Author: buddly27

doc/_extensions/github_user.py

@@ -0,0 +1,18 @@
+from docutils import nodes
+from sphinx.util.docutils import SphinxRole
+
+class GitHubUserRole(SphinxRole):
+    def run(self):
+        username = self.text.strip()
+        url = f"https://github.com/{username}"
+        node = nodes.reference(rawtext=self.rawtext, text=f"@{username}", refuri=url, **self.options)
+        return [node], []
+
+def setup(app):
+    """Register extension with Sphinx."""
+    app.add_role('github_user', GitHubUserRole())
+    return {
+        'version': '1.0',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

doc/conf.py

@@ -12,7 +12,7 @@
 # -- General ------------------------------------------------------------------
 
 # Extensions.
-extensions = ["changelog", "sphinx.ext.intersphinx"]
+extensions = ["changelog", "github_user", "sphinx.ext.intersphinx"]
 
 # The suffix of source filenames.
 source_suffix = ".rst"

doc/release/release_notes.rst

@@ -4,6 +4,13 @@
 Release Notes
 *************
 
+.. release:: Upcoming
+
+    .. change:: changed
+
+        Updated the :func:`pytest_discover_tests` function to avoid rediscovering tests with
+        every build. Thanks :github_user:`mhx`!
+
 .. release:: 0.11.0
     :date: 2024-10-15