-
Notifications
You must be signed in to change notification settings - Fork 9
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
Use lcviz version in all docs links #128
Conversation
5ca2fa4
to
6cd4982
Compare
6cd4982
to
e54c7ce
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #128 +/- ##
==========================================
- Coverage 93.92% 91.21% -2.72%
==========================================
Files 37 41 +4
Lines 1598 2082 +484
==========================================
+ Hits 1501 1899 +398
- Misses 97 183 +86 ☔ View full report in Codecov by Sentry. |
@@ -134,7 +136,13 @@ def __init__(self, *args, **kwargs): | |||
self.app._add_style((__file__, 'lcviz_style.vue')) | |||
|
|||
# set the link to read the docs | |||
self.app.docs_link = "https://lcviz.readthedocs.io" | |||
self.app.vdocs = 'latest' if 'dev' in __version__ else 'v'+__version__ |
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.
to test, override this with 'v0.4.1'
and see that all links in plugins and the app toolbar point correctly to that tagged release on RTD.
Is this only necessary for RTD? If so, can it be solved with the same approach as spacetelescope/jdaviz#3080? |
this is links from the app to RTD (like the button in the app-toolbar and "learn more" links in each plugin - so no). |
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.
This works for me locally. I regret that any of this needs to be accomplished by observing a traitlet, but it's not clear how to avoid that without something much more complicated.
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
This PR ensures that all internal docs links buttons point to the correct version on RTD, and don't use the upstream version tag set by jdaviz.