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

Add configurations to show the 'Edit on GitHub' button #222

Merged
merged 1 commit into from Jul 5, 2021
Merged

Add configurations to show the 'Edit on GitHub' button #222

merged 1 commit into from Jul 5, 2021

Conversation

seisman
Copy link
Contributor

@seisman seisman commented Jul 5, 2021

Currently, each page on the documentation shows a "View page source" link, which links to the plain text source file:
image

It's more useful to link directly to the source files in the GitHub repository, because the source files are rendered well on GitHub and are easier to read. It's also much easier for users to submit quick fixes for typos.

image

The html_context is documented in readthedocs/sphinx_rtd_theme#465.

It works well in my other projects, so I expect it should work well for mspass too. However, I can't test it because for me, it's difficult to build mspass from source codes locally.

@codecov-commenter
Copy link

codecov-commenter commented Jul 5, 2021

Codecov Report

Merging #222 (70c08f6) into master (82d6582) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #222      +/-   ##
==========================================
- Coverage   43.22%   43.21%   -0.01%     
==========================================
  Files         117      117              
  Lines       14899    14899              
==========================================
- Hits         6440     6439       -1     
- Misses       8459     8460       +1     
Impacted Files Coverage Δ
python/mspasspy/db/database.py 82.04% <0.00%> (-0.08%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 82d6582...70c08f6. Read the comment docs.

@wangyinz
Copy link
Member

wangyinz commented Jul 5, 2021

Great! This is what I have thought about but did not have the chance to try it out. Thanks for contributing!

@wangyinz wangyinz merged commit 66e10b6 into mspass-team:master Jul 5, 2021
@seisman seisman deleted the github-link branch July 5, 2021 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants