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 conf.py to use packaging to detect dev vs release versions #631

Merged
merged 5 commits into from
Mar 17, 2025

Conversation

psobolewskiPhD
Copy link
Member

@psobolewskiPhD psobolewskiPhD commented Mar 15, 2025

References and relevant issues

If you go to dev docs right now:
https://napari.org/dev/index.html
The sidebar link to the release notes is broken, I think because the version is being treated as a release and not dev.
It points to:
https://napari.org/dev/release/release_0_6_0a0.html
which doesn't exist.
instead of the index.html which would be used for a dev release:
https://napari.org/dev/release/index.html

So in this PR I use packaging to check if a version is a dev version and also uses packaging to get just the base version number of pre-releases, so we will get release_0_6_0.html

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 15, 2025
Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thank you! 🚢

@psobolewskiPhD
Copy link
Member Author

Checking:
https://output.circle-artifacts.com/output/job/c902cc9c-bfe0-46f3-90de-6c69c2cecbdf/artifacts/0/docs/docs/_build/html/index.html
Looks like it worked

@psobolewskiPhD psobolewskiPhD marked this pull request as ready for review March 15, 2025 20:28
@psobolewskiPhD psobolewskiPhD added this to the 0.6.0 milestone Mar 15, 2025
@willingc
Copy link
Contributor

I'm not sure if it's caching or the deploy workflow but stable says (0.5.6) but directs to 0.6.0 🤷🏼‍♀️

@psobolewskiPhD
Copy link
Member Author

Can you explain where? when I go to napari.org stable is 0.5.6 and has for example the missing screenshot in installation guide. When I use the circle build, it's just building dev, so it should also have stable as napari.org stable.

Czaki
Czaki previously requested changes Mar 16, 2025
Copy link
Contributor

@Czaki Czaki left a comment

Choose a reason for hiding this comment

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

We should deploy prerelease to separate dirctory. (for 0.6.0a1 it should be 0.6.0) but we should not parse it manually when packaging is available.

@Czaki
Copy link
Contributor

Czaki commented Mar 16, 2025

Please update the title to reflect the current state

@psobolewskiPhD psobolewskiPhD changed the title Update conf.py so that pre-releases are still flagged as dev Update conf.py to use packaging to detect dev vs release versions Mar 16, 2025
@jni jni dismissed Czaki’s stale review March 17, 2025 03:05

Comments were addressed + suggestions were accepted

@jni jni merged commit 1afa6b5 into napari:main Mar 17, 2025
11 checks passed
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.

4 participants