From b6ca0badf70ed2211932b19046f9f1de12610691 Mon Sep 17 00:00:00 2001 From: eecavanna <134325062+eecavanna@users.noreply.github.com> Date: Sat, 14 Dec 2024 20:01:20 -0800 Subject: [PATCH] Enable "Edit on GitHub" link by defining `:github_url:` in `index.rst` --- docs/index.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index b042beb..9ce4991 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,11 @@ +:github_url: https://github.com/microbiomedata/enviroMS/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 + Natural Organic Matter Workflow ================================ @@ -99,4 +107,4 @@ Version History Point of contact ---------------- -Package maintainer: Yuri E. Corilo \ No newline at end of file +Package maintainer: Yuri E. Corilo