docs: format doc version as major.minor
Metadata
Current evaluation
Merged in PR #2649 (commit fa566418): docs/conf.py now derives the Sphinx release string as major.minor from charmcraft.__version__ instead of using the full patch version, with a 'dev' value for latest RTD builds.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit fa566418, with 3 approvals and only the unrelated typecheck-with-ty check failing. It changed docs/conf.py to compute release = f"{major}.{minor}" from charmcraft.__version__, and the current file still carries that logic (later refined by follow-ups such as #2734/#2787).
Evaluated by: mr-cal-bot
No scores available.
Issue body
What it says on the tin.
---
- [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md).
- [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/).
- [x] I've successfully run `make lint && make test`.
- [x] I've added or updated any relevant documentation.
- [x] I've updated the relevant release notes.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #2649 (commit fa566418): docs/conf.py now derives the Sphinx release string as major.minor from charmcraft.__version__ instead of using the full patch version, with a 'dev' value for latest RTD builds. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2649 (commit fa566418), updating documentation to display Charmcraft versions as major.minor without the patch component. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in PR #2649 (commit fa566418), updating documentation to display versions as major.minor instead of including the patch component. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged a documentation update that formats version strings as major.minor. Approved by three reviewers and merged despite a failing typecheck CI, modifying a single file. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a documentation update that formats the version string as major.minor. The maintainer-authored change passed lint and test checks and was successfully integrated without additional review comments. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#2734
(confidence 70%)
Follow-up commit 5fb6af27 'docs: improve versioning logic' further adjusted the same docs/conf.py version handling.
-
Related To:
canonical/charmcraft#2787
(confidence 70%)
Commit bf3b6478 'docs: fix versioning logic' continued refining the version string logic introduced here.
-
Related To:
canonical/charmcraft#2830
(confidence 60%)
Commit 8861b8ff 'docs: fix version string in title' shows the version string needed later corrections in docs/conf.py.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #6166 docs: format doc version as major.minor | snapcraft | merged | Merged in #6166 (9ba26487a), formatting Sphinx doc versions as major.minor; the change was also merged into hotfix/8.14 via #6173 (ad93035f0). | |
| #520 docs: format doc version as major.minor | starbase | merged | Merged in commit 66911da: documentation version metadata is now formatted as major.minor. | |
| #1189 docs: format doc version as major.minor | rockcraft | merged | Merged into main as fc0e073a, replacing #1185; documentation now renders release versions as major.minor and labels latest RTD builds as dev. | |
| #6173 docs: format doc version as major.minor | snapcraft | merged | Merged as ad93035f0: documentation now displays Snapcraft versions as major.minor, with latest Read the Docs builds labeled dev. | |
| #1185 docs: format doc version as major.minor | rockcraft | closed | Closed as superseded by rockcraft#1189, which merged the major.minor documentation formatting change in commit fc0e073a. | |
| #588 docs: fix version in title | starbase | merged | Merged docs fix (commit 23328cd): docs page titles now display major.minor version for local, PR and branch builds; only the 'latest' branch shows 'dev', following the RTD version slug simplification. | |
| #1334 docs: fix version string on latest | rockcraft | merged | Merged PR #1334 fixed docs version strings: local, PR, and branch builds show major.minor, while latest shows dev. Commit: b2bc69ce. | |
| #2832 docs: fix version string for 4.x | charmcraft | merged | Merged #2832 corrected docs title versioning for Charmcraft 4.x: local, PR, and branch builds show major/minor; the latest branch shows dev. | |
| #2830 docs: fix version string for 'latest' | charmcraft | merged | Docs-only PR merged: RTD page titles now show major.minor for local/PR/branch builds, with 'latest' branch showing 'dev', following simplification of RTD version slugs (+2/-6 in one file). | |
| #2831 docs: fix version string for 3.x | charmcraft | merged | Merged #2831 to display the 3.x major/minor version in docs titles; the latest branch remains labeled dev after Read the Docs slug simplification. |