fix(docs): fix docs for canonical-sphinx 0.2
Metadata
Current evaluation
Merged #498 in commit 8b2b8f36, replacing the diataxis grid with a list-table to restore documentation builds using canonical-sphinx 0.2.
Resolution: closed resolved
Reason: PR #498 was approved and merged as commit 8b2b8f36. It replaced the diataxis grid with a standard reStructuredText list-table, resolving build failures caused by canonical-sphinx 0.2.
Evaluated by: mr-cal-bot
No scores available.
Issue body
This replaces the diataxis grid with a list-table. https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table
Needed because the update to canonical-sphinx caused doc builds to fail and this was how they fixed it for themselves. https://github.com/canonical/canonical-sphinx/commit/e67baa49c47bb99319cfb720ff0964dbed6795eb
- [ ] 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 #498 in commit 8b2b8f36, replacing the diataxis grid with a list-table to restore documentation builds using canonical-sphinx 0.2. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit 8b2b8f36 "fix(docs): fix docs for canonical-sphinx 0.2 (#498)", replacing the diataxis grid directive with a list-table in release-notes/index.rst to fix doc builds under canonical-sphinx 0.2. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #498 in commit 8b2b8f36, replacing the diataxis grid with a list-table to fix documentation build failures with canonical-sphinx 0.2. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation fix replacing the diataxis grid with a list-table to resolve build failures from the canonical-sphinx 0.2 update. Approved by two reviewers and passed CI. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #676 build(deps): bump canonical-sphinx to 0.2.0 | craft-providers | merged | Merged PR #676 updated canonical-sphinx to 0.2.0, enabling the new documentation grid template; landed as commit 6d2dda7. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. | |
| #865 build(deps): use correct canonical-sphinx | craft-parts | merged | Merged PR #865 corrected the canonical-sphinx build dependency, replacing the incorrect declaration to address documentation breakages associated with version 0.2.0. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged #23 to migrate the documentation build to canonical-sphinx, resolving the proposed change in commit daf794a. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged PR #325 in commit 8ca97e1a, migrating the docs to canonical-sphinx and removing unused extensions and configuration. | |
| #158 build(docs): add sphinx sitemap | imagecraft | merged | Merged in canonical/imagecraft#158 (commit 6be8578), adding sphinx-sitemap, generating sitemaps during documentation builds, and using dirhtml locally. | |
| #135 docs(deps): update canonical-sphinx | craft-archives | merged | Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals. |