Enable "Edit on GitHub" link by defining github_url in file

microbiomedata · Dec 14, 2024 · 4978bc7 · 4978bc7
1 parent 924d9ae
commit 4978bc7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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)
 =============================