deploy: ae41736

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b04b245800c5327c44239bba5c012d65
+tags: 645f666f9bcd5a90fca523b33c5a78b7

CNAME

@@ -0,0 +1 @@
+docs.openverse.org

_downloads/7c06dc7fa79c7a8feb2fbe872ad1e362/link_usernames.py

@@ -0,0 +1,50 @@
+"""GitHub Username Linking
+
+Based on: https://www.sphinx-doc.org/en/master/extdev/appapi.html#event-source-read
+and: https://stackoverflow.com/a/31924901/3277713  CC BY-SA 3.0 by C_Z_
+
+This extension replaces username references of the form `@username` with a link
+to the user's GitHub profile. In order to prevent adding references to existing
+existing links (e.g. `[@username](...)`, whitespace is required in front of the `@`.
+
+The GITHUB_IGNORE_USERNAMES set contains usernames that should not be linked but may
+appear to be usernames in the documentation.
+"""
+import re
+
+from sphinx.application import Sphinx
+from sphinx.util import logging
+
+
+logger = logging.getLogger(__name__)
+
+# Format to use for the link to the GitHub profile
+GITHUB_USERNAME_TEMPLATE = "https://github.com/{}"
+# Regex to match username references
+GITHUB_USERNAME_REGEX = re.compile(
+    r"""
+\ # Required initial whitespace
+@([A-Za-z0-9-]+)  # Match @ then any alphanumeric character or - for the username
+""",
+    flags=re.VERBOSE,
+)
+GITHUB_IGNORE_USERNAMES = {"todo", "WordPress", "username", "defaultValue"}
+
+
+def _replace_username(match: re.Match) -> str:
+    username = match.group(1)
+    if username in GITHUB_IGNORE_USERNAMES:
+        logger.debug(f"Ignoring username reference: {username}")
+        return match.group(0)
+    logger.debug(f"Replacing username reference: {username}")
+    return f" [@{username}]({GITHUB_USERNAME_TEMPLATE.format(username)})"
+
+
+def replace_username_references(app, docname, source):
+    logger.debug(f"In file: {docname}")
+    source[0] = GITHUB_USERNAME_REGEX.sub(_replace_username, source[0])
+
+
+def setup(app: Sphinx):
+    # Hook for running the replace username references when the source file is read
+    app.connect("source-read", replace_username_references)