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

Use lcviz version in all docs links #128

Merged
merged 4 commits into from
Jul 17, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Jul 17, 2024

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.

@kecnry kecnry added this to the 0.4.2 milestone Jul 17, 2024
Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.21%. Comparing base (7b78df5) to head (acbab50).
Report is 27 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@kecnry kecnry marked this pull request as ready for review July 17, 2024 14:15
@kecnry kecnry requested a review from bmorris3 July 17, 2024 14:15
@@ -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__
Copy link
Member Author

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.

@bmorris3
Copy link
Contributor

Is this only necessary for RTD? If so, can it be solved with the same approach as spacetelescope/jdaviz#3080?

@kecnry
Copy link
Member Author

kecnry commented Jul 17, 2024

this is links from the app to RTD (like the button in the app-toolbar and "learn more" links in each plugin - so no).

Copy link
Contributor

@bmorris3 bmorris3 left a 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.

@kecnry kecnry merged commit 3853abe into spacetelescope:main Jul 17, 2024
12 of 13 checks passed
Copy link

lumberbot-app bot commented Jul 17, 2024

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v0.4.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 3853abe51f719805f379b8b5015fd5bbd53e0088
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #128: Use lcviz version in all docs links'
  1. Push to a named branch:
git push YOURFORK v0.4.x:auto-backport-of-pr-128-on-v0.4.x
  1. Create a PR against branch v0.4.x, I would have named this PR:

"Backport PR #128 on branch v0.4.x (Use lcviz version in all docs links)"

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 Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

kecnry added a commit to kecnry/lcviz that referenced this pull request Jul 17, 2024
@kecnry kecnry deleted the docs-links-versions branch July 17, 2024 20:32
@kecnry kecnry mentioned this pull request Jul 17, 2024
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.

2 participants