Update mkdocs macro glossary to take optional link text

This allows linking to a glossary term with custom text for the link.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

docs/_scripts/macros.py

@@ -45,19 +45,20 @@ def define_env(env: macros.MacrosPlugin) -> None:
     env.variables["code_annotation_marker"] = _CODE_ANNOTATION_MARKER
 
     @env.macro  # type: ignore[misc]
-    def glossary(term: str) -> str:
+    def glossary(term: str, text: str | None = None) -> str:
         """Create a link to the glossary entry for the given term.
 
         Args:
             term: The term to link to.
+            text: The text to display for the link. Defaults to the term.
 
         Returns:
             The Markdown link to the glossary entry for the given term.
         """
         current_path = pathlib.Path(env.page.file.src_uri)
         glossary_path = pathlib.Path("user-guide/glossary.md")
         link_path = glossary_path.relative_to(current_path.parent)
-        return f"[{term}]({link_path}#{_slugify(term)})"
+        return f"[{text or term}]({link_path}#{_slugify(term)})"
 
     # The code below is a temporary workaround to make `mkdocs-macros` work with
     # `mkdocstrings` until a proper `mkdocs-macros` *pluglet* is available. See