Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
eecavanna opened this issue Dec 14, 2024 · 0 comments · Fixed by #65
Closed

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

eecavanna opened this issue Dec 14, 2024 · 0 comments · Fixed by #65
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@eecavanna
Copy link
Contributor

Here's the exact snippet I want to add to the very top of the index.rst file:

:github_url: https://github.com/microbiomedata/metaMAGs/blob/master/docs/index.rst

It is a 1-item "field list," as defined here:

We would be using it to force the "Edit on GitHub" button to use the specified URL; as described here:

If we do this, the "Edit on GitHub" button on the centralized documentation website (downstream from this repo) will point to the correct source file.

@eecavanna eecavanna added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 14, 2024
@eecavanna eecavanna self-assigned this Dec 14, 2024
@eecavanna eecavanna changed the title Add :github_url: field to top of index.rst (to set up "Edit on GitHub" link) Enable "Edit on GitHub" link by defining :github_url: in index.rst Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
1 participant