From 3556d281f79dcc0d5b77db7408fb4fab65d47a58 Mon Sep 17 00:00:00 2001
From: eecavanna <134325062+eecavanna@users.noreply.github.com>
Date: Sat, 14 Dec 2024 19:43:14 -0800
Subject: [PATCH] Enable "Edit on GitHub" link by defining `:github_url:` in
 `index.rst`

---
 docs/index.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index e93540d..a8b8416 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,3 +1,11 @@
+:github_url: https://github.com/microbiomedata/metaT_ReadsQC/blob/main/docs/index.rst
+
+..
+   Note: The above `github_url` field is used to force the target of the "Edit on GitHub" link
+         to be the specified URL. That makes it so the link will work, regardless of the Sphinx
+         site the file is incorporated into. You can learn more about the `github_url` field at:
+         https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-github_url
+
 MetaT Reads QC Workflow (v0.0.7)
 =============================