docs: Update mkdocs edit on GitHub to work with addons (#5164)

Switches the URL between core and addon tools based on the 'Available at' which is already present in the generated Markdown files.

Author: cwhite911

man/mkdocs/mkdocs.yml

@@ -5,7 +5,7 @@ site_url: https://grass.osgeo.org/grass-stable/manuals/
 
 # Repository information
 repo_name: GitHub
-repo_url: https://github.com/OSGeo/grass
+repo_url: https://github.com/OSGeo # Set to OSGeo so we can added grass and grass-addons
 edit_uri_template: edit/main/{path!q}
 
 # Project Configuration

man/mkdocs/overrides/partials/actions.html

@@ -4,7 +4,7 @@
     {# Default to the normal edit URL #}
     {% set ghpath = github_path(toolname, config.extra.source_docs) %}
     {% if ghpath %}
-        {% set custom_edit_url = page.edit_url | replace(toolname, ghpath ~ "/" ~ toolname) %}
+        {% set custom_edit_url = page.edit_url | replace(page.edit_url, ghpath ~ "/" ~ toolname ~ ".md") %}
         {% if "content.action.edit" in features %}
             <a href="{{ custom_edit_url }}" title="{{ lang.t('action.edit') }}" class="md-content__button md-icon">
                 {% set icon = config.theme.icon.edit or "material/file-edit-outline" %}

man/mkdocs/scripts/hook_list_scripts.py

@@ -11,31 +11,46 @@ def github_path(toolname: str, source_docs: dict[str, str]):
         return None
 
 
+def github_edit_path(ghpath: str, base_repo_url: str):
+    """Return the GitHub edit path for the given path"""
+    path_parts = ghpath.split("/")
+
+    # Gracefully handle invalid paths
+    if len(path_parts) < 3:
+        return None
+
+    repo = path_parts[0].strip()
+    doc_path = "/".join(path_parts[2:]).strip()  # Drop repo_name/tree
+    return f"{base_repo_url}/{repo}/edit/{doc_path}"
+
+
 def on_env(env: Environment, config, files):
     """Enable loopcontrols extension in Jinja2"""
     env.add_extension("jinja2.ext.loopcontrols")
     env.globals["github_path"] = github_path
     return env
 
 
-def on_config(config):
+def set_extra_source_docs(source_dir: str, config: dict):
     """
     Read the list of tools from the source directory and
     store it in MkDocs extra config. These are used to generate
     the correct links to the documentation in GitHub.
     """
-    source_dir = Path("source")
+
+    base_repo_url = config["repo_url"]  # Set in mkdocs.yml as repo_url
+    source_dir = Path(source_dir)
 
     # Dict to store the documentation path for each tool in GitHub
     # the key is the doc name and the value is the path in the GitHub repository
     source_docs = {}
 
     # Read the source files and extract the GitHub path from the Available at link at the bottom of the page
     pattern = re.compile(
-        r"Available at:\s*\[(?P<text>.*?)\]\(https://github\.com/OSGeo/grass/tree/main/(?P<gh_path>.*?)\)"
+        r"Available at:\s*\[(?P<text>.*?)\]\(https://github\.com/OSGeo/(?P<gh_path>.*?)\)"
     )
 
-    for file in source_dir.glob("*.md"):
+    for file in source_dir.rglob("*.md"):
         with file.open() as f:
             for line in f:
                 match = pattern.search(line)
@@ -48,8 +63,19 @@ def on_config(config):
                     toolname = re.sub(
                         r"\s*source\s+code\s*$", "", text, flags=re.IGNORECASE
                     ).strip()
-                    source_docs[toolname] = gh_path
+                    print(f"Found {toolname} at {gh_path}")
+                    source_docs[toolname] = github_edit_path(gh_path, base_repo_url)
 
     # Store in MkDocs extra config
-    config["extra"]["source_docs"] = source_docs
+    return source_docs
+
+
+def on_config(config):
+    """
+    Runs on MkDocs config to set the extra config with the source_docs
+    """
+
+    # Store in MkDocs extra config
+    config["extra"]["source_docs"] = set_extra_source_docs("source", config)
+
     return config