From 13312dad9a3d0426256aaf33eff9439d368e0b77 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= <gaborjbernat@gmail.com>
Date: Fri, 30 Oct 2026 12:04:36 -0700
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20link=20pages=20back=20to?=
 =?UTF-8?q?=20the=20repository?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Set Furo's source_repository so each page gets view and edit buttons
pointing at GitHub, and add a GitHub footer icon.

Closes #174
---
 docs/_static/github.svg    |  1 +
 docs/changelog/174.doc.rst |  1 +
 docs/conf.py               | 19 ++++++++++++++++---
 3 files changed, 18 insertions(+), 3 deletions(-)
 create mode 100644 docs/_static/github.svg
 create mode 100644 docs/changelog/174.doc.rst

diff --git a/docs/_static/github.svg b/docs/_static/github.svg
new file mode 100644
index 0000000..cc2be72
--- /dev/null
+++ b/docs/_static/github.svg
@@ -0,0 +1 @@
+<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path></svg>
diff --git a/docs/changelog/174.doc.rst b/docs/changelog/174.doc.rst
new file mode 100644
index 0000000..4b9a458
--- /dev/null
+++ b/docs/changelog/174.doc.rst
@@ -0,0 +1 @@
+Link every documentation page to its source and edit view on GitHub, and add a GitHub icon to the footer.
diff --git a/docs/conf.py b/docs/conf.py
index 04effbe..8cb145b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -10,6 +10,7 @@
 
 company = "tox-dev"
 name = "python-discovery"
+repository = f"https://github.com/{company}/{name}"
 version = ".".join(__version__.split(".")[:2])
 release = __version__
 copyright = f"2026-{datetime.now(tz=timezone.utc).year}, {company}"  # ruff:ignore[builtin-variable-shadowing]
@@ -31,9 +32,9 @@
 autosectionlabel_maxdepth = 2
 
 extlinks = {
-    "issue": ("https://github.com/tox-dev/python-discovery/issues/%s", "#%s"),
-    "pr": ("https://github.com/tox-dev/python-discovery/pull/%s", "PR #%s"),
-    "pull": ("https://github.com/tox-dev/python-discovery/pull/%s", "PR #%s"),
+    "issue": (f"{repository}/issues/%s", "#%s"),
+    "pr": (f"{repository}/pull/%s", "PR #%s"),
+    "pull": (f"{repository}/pull/%s", "PR #%s"),
     "user": ("https://github.com/%s", "@%s"),
 }
 
@@ -60,6 +61,18 @@
     "light_logo": "logo.svg",
     "dark_logo": "logo.svg",
     "sidebar_hide_name": True,
+    "source_repository": repository,
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": repository,
+            # footer icons are inlined into every page, so a path to the image would not resolve
+            "html": (Path(__file__).parent / "_static" / "github.svg").read_text(encoding="utf-8"),
+            "class": "",
+        },
+    ],
 }
 html_css_files = ["custom.css"]