Merge pull request #31 from microbiomedata/30-configure-edit-on-githu…

…b-link-by-adding-github_url-field-to-indexrst-file

Enable "Edit on GitHub" link by defining `:github_url:` in `index.rst`

docs/index.rst

@@ -1,3 +1,11 @@
+:github_url: https://github.com/microbiomedata/metaAssembly/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
+
 Metagenome Assembly Workflow (v1.0.7)
 =====================================