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

Pin npe2 version to match installed one #175

Merged
merged 3 commits into from Jun 8, 2023
Merged

Conversation

Czaki
Copy link
Contributor

@Czaki Czaki commented Jun 8, 2023

Description

The napari/npe2#294 breaks the docs building as we use the most recent npe2 repository, not matching npe2 version. In this PR I add git checkout call to have the npe2 repository cloned in a version matching the installed npe2 version.

Type of change

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment

References

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 8, 2023
Copy link
Contributor

@aganders3 aganders3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me with one confusing piece.

docs/_scripts/prep_docs.py Outdated Show resolved Hide resolved
Co-authored-by: Ashley Anderson <aganders3@gmail.com>
@psobolewskiPhD
Copy link
Member

Does this affect the dev docs at all, in terms of being up-to-date for dev changes in npe2?

Comment on lines +25 to +26
if not parse(npe2_version).is_devrelease:
check_call(f"git checkout tags/v{npe2_version}".split(), cwd=NPE)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check disable checkout if development version of npe2 is installed in workflow. So it is enough to add pip install git+https://github.com/napari/npe2 to the workflow to have dev version of docs.

Copy link
Contributor

@melonora melonora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems good to me. I was able to complete the build. However in the environment on gitpod I was not able to complete the build with PyQt5. I had to use Pyside or otherwise I would get an error for a visual draw. I will open an issue for this.

@Czaki
Copy link
Contributor Author

Czaki commented Jun 8, 2023

I will merge it not to restore working napari repo tests

@Czaki Czaki merged commit 11cb46f into napari:main Jun 8, 2023
5 checks passed
@Czaki Czaki deleted the pin_npe2 branch June 8, 2023 23:36
Czaki added a commit to napari/napari that referenced this pull request Jun 21, 2023
@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
Czaki added a commit to napari/napari that referenced this pull request Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants