From 4978bc7fff942cc108f2ec670248ebfa0992bd9f Mon Sep 17 00:00:00 2001
From: eecavanna <134325062+eecavanna@users.noreply.github.com>
Date: Fri, 13 Dec 2024 22:36:36 -0800
Subject: [PATCH] Enable "Edit on GitHub" link by defining `github_url` in file

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

diff --git a/docs/index.rst b/docs/index.rst
index c3fb797..b9e2795 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,3 +1,11 @@
+:github_url: https://github.com/microbiomedata/ReadsQC/blob/master/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
+
 Reads QC Workflow (v1.0.13)
 =============================