feat: render versions in doc urls
Metadata
Current evaluation
Merged in #380 via commit 600cec0e, adding versioned documentation URL rendering and version-aware Emitter links; fixes #368.
Resolution: closed resolved
Reason: Approved PR #380 was merged as commit 600cec0e. It added util.render_doc_url() and version-aware Emitter documentation links, resolving #368.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This commit adds two new features:
- An util.render_doc_url() which creates a versioned url given an url with a `{version}` placeholder and a version value;
- Support for passing a rendered base url to the Emitter's init(), so that helper documentation links in error messages can contain the correct version (instead of the default readthedocs "stable" or "latest").
Fixes #368
- [ ] Have you followed the guidelines for contributing?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in #380 via commit 600cec0e, adding versioned documentation URL rendering and version-aware Emitter links; fixes #368. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/craft-application#380 via 600cec0e, adding versioned documentation URL rendering and version-aware Emitter links, resolving #368. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged following two approvals and passing CI. Adds util.render_doc_url() and updates Emitter initialization to generate versioned documentation URLs in error messages, resolving issue #368. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-application#368
(confidence 100%)
PR #380 explicitly states that it fixes the versioned documentation URL issue tracked in #368.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #368 Support versioned doc urls | craft-application | closed | Implemented version-aware documentation URL rendering in merged PR #380 (commit 600cec0e), building on the base URL support introduced by #361. | |
| #257 feat: split the docs url into base and slug | craft-cli | merged | Merged documentation URL refactor: CraftError now stores a topic slug while Emitter combines it with the configured docs base URL. Implemented in commit 2faeeb7 (#257). |