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

Update version switcher #3291

Merged
merged 4 commits into from Dec 25, 2023

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Dec 23, 2023

Fix documentation version switcher.

  • For release version, use the major and minor increment
  • For dev version, set the version to dev
  • in both case, the version, it is matched against the documentation available in hyperspy/hyperspy-doc

The json file providing the link is in the dev version and will need to updated after a minor or major release - the content of this json file could automated too with a python script generating its content when building the doc but for now, this should do!

Progress of the PR

  • Fix documentation version switcher,
  • [n/a] update docstring (if appropriate),
  • update user guide (if appropriate),
  • add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
  • add tests,
  • ready for review.

Copy link

codecov bot commented Dec 23, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (60f27ff) 80.25% compared to head (1812dd7) 80.25%.

Additional details and impacted files
@@                 Coverage Diff                 @@
##           RELEASE_next_patch    #3291   +/-   ##
===================================================
  Coverage               80.25%   80.25%           
===================================================
  Files                     147      147           
  Lines                   21859    21859           
  Branches                 5143     5143           
===================================================
  Hits                    17542    17542           
  Misses                   3111     3111           
  Partials                 1206     1206           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jlaehne
Copy link
Contributor

jlaehne commented Dec 23, 2023

Branch is protected and I can't merge?

@ericpre
Copy link
Member Author

ericpre commented Dec 24, 2023

@jlaehne, I have updated the protected branch settings, can you try now?

@jlaehne jlaehne merged commit 85cdf6d into hyperspy:RELEASE_next_patch Dec 25, 2023
24 checks passed
@ericpre ericpre deleted the update_version_switcher branch January 2, 2024 14:52
@ericpre ericpre added this to the v2.0.1 milestone Jan 13, 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.

None yet

2 participants