Skip to content

Commit

Permalink
Merge pull request #64 from microbiomedata/63-define-github_url-in-12…
Browse files Browse the repository at this point in the history
…_metabolomics-master-branch

Enable "Edit on GitHub" link by defining `:github_url:` in `index.rst`
  • Loading branch information
eecavanna authored Dec 15, 2024
2 parents 6e1f2ac + 1eb43b9 commit fa2bfd7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
:github_url: https://github.com/microbiomedata/metaMS/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
Metabolomics Workflow
==============================

Expand Down Expand Up @@ -94,4 +102,4 @@ Version History
Point of contact
----------------

Package maintainer: Yuri E. Corilo <[email protected]>
Package maintainer: Yuri E. Corilo <[email protected]>

0 comments on commit fa2bfd7

Please sign in to comment.