Fix documentation version display#611
Merged
laughingman7743 merged 1 commit intomasterfrom Oct 18, 2025
Merged
Conversation
- Add fetch-depth: 0 to docs workflow to fetch all git history and tags - Add uv build step before make docs to generate _version.py with hatch-vcs - Add Furo theme options for source repository links This ensures the documentation shows the correct version (e.g., v3.18.1.dev7) instead of incorrect version strings like v0.1.dev1. Fixes #607 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This was referenced Oct 18, 2025
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
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
Fixes the documentation version display issue where the docs showed incorrect version strings like
v0.1.dev1+gf45815e0instead of the correct version.Problem
The documentation was showing
PyAthena v0.1.dev1+gf45815e0because:pyathena/_version.pywas not being generated by hatch-vcs during docs builddocs/conf.pyfell through to "unknown"Solution
1. Fetch Full Git History
2. Build Package Before Docs
This allows hatch-vcs to:
v3.18.0)v3.18.1.dev7+g8bf8d8582.d202510183. Add Furo Theme Options
Added source repository configuration to
docs/conf.pyfor better navigation.Before vs After
Before:
PyAthena v0.1.dev1+gf45815e0 documentationAfter:
PyAthena v3.18.1.dev7+g8bf8d8582.d20251018 documentationTesting
Tested locally with:
The generated HTML shows the correct version in the title and sidebar.
Related Issues
Fixes #607
Notes
_version.pyfile is auto-generated during build and not tracked in git🤖 Generated with Claude Code