docs: Fix version parsing to handle dev version formats #996
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The regex pattern in docs/conf.py failed to parse development version strings like 0.1.dev1+g83a54e6c9 produced by hatch-vcs on ReadTheDocs. The pattern now handles both release versions (0.25.0) and dev versions with optional patch numbers.
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #996 +/- ##
=======================================
Coverage 73.03% 73.03%
=======================================
Files 25 25
Lines 1836 1836
Branches 250 250
=======================================
Hits 1341 1341
Misses 410 410
Partials 85 85 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
docs/conf.pyto handle development version strings like0.1.dev1+g83a54e6c9produced by hatch-vcs on ReadTheDocs0.25.0) and dev versions with optional patch numbersThis is a follow-up to #995. The ReadTheDocs build was still failing because the version parsing regex didn't handle the dev version format that hatch-vcs produces when installing from source.
Test plan
0.25.0,0.25.1.dev2+g83a54e6c,0.1.dev1+g83a54e6c9uv run sphinx-build -W -E docs docs/_build/htmlbuilds successfully