Update docs/confi.py to stop inverting version and release - #32
Merged
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
🟢 Approval recommended
The change corrects version/release semantics in docs/conf.py and aligns with Sphinx expectations without introducing additional risk.
Pull request overview
Fixes the Sphinx docs version metadata so that release contains the full project version while version contains the short X.Y form, matching Sphinx’s expected semantics and improving how version info renders across the generated documentation.
Changes:
- Set
releaseto the fullpyproject.tomlversion string. - Derive
versionas the major/minor (X.Y) prefix fromrelease.
File summaries
| File | Description |
|---|---|
| docs/conf.py | Corrects Sphinx version/release assignment so docs show the proper short and full version strings. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
pkthong
approved these changes
Sep 2, 2026
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.
What does this Pull Request accomplish?
Ensure release and version show up properly.
Why should this Pull Request be merged?
version is accidentally being represented as release and vice versa which causes it to show up wonky in docs
What testing has been done?
PR build.