-
Notifications
You must be signed in to change notification settings - Fork 73
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
Sync notebook github links in HTML docs to the git commit used to build them #3080
Conversation
In the RTD build for this PR, you can prove to yourself that this is working by trying out the following links and comparing the commit hash to the most recent commit hash in this PR:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3080 +/- ##
=======================================
Coverage 88.79% 88.79%
=======================================
Files 111 111
Lines 17236 17236
=======================================
Hits 15305 15305
Misses 1931 1931 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Simpler than what I thought it would be. Seems to work and RTD is happy. Thanks!
…ocs to the git commit used to build them
…0-on-v3.10.x Backport PR #3080 on branch v3.10.x (Sync notebook github links in HTML docs to the git commit used to build them)
Description
The HTML docs on RTD like this page point to directories on github like https://github.com/spacetelescope/jdaviz/tree/main/notebooks. We've changed the default RTD page to
stable
, which isn't the same asmain
, so the notebooks linked on RTD will be out of sync with the rest of the HTML docs whenevermain != stable
.This PR gets the git commit hash at the time the docs are built, and injects that hash into the github URLs for docs links.
Change log entry
CHANGES.rst
? If you want to avoid merge conflicts,list the proposed change log here for review and add to
CHANGES.rst
before merge. If no, maintainershould add a
no-changelog-entry-needed
label.Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
trivial
label.