fix(docs): fix docs for canonical-sphinx 0.2
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a documentation fix replacing the diataxis grid with a list-table to resolve build failures from the canonical-sphinx 0.2 update. The change applies an upstream solution and was approved after a reviewer requested more context. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #209 docs: use canonical-sphinx | starbase | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, modifying two files with 45 additions and 36 deletions. | |
| #325 docs: use canonical-sphinx | craft-application | merged | Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines). | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, the change modifies three files, removing 167 lines and adding 45 to standardize the build configuration. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged documentation update to use canonical-sphinx. Approved by two reviewers, passed CI and codecov checks, and successfully integrated into the codebase. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged after two approvals and passing CI. Updates documentation to use canonical-sphinx, modifying 7 files with a net reduction of 72 lines. | |
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged documentation update to adopt canonical-sphinx. Added the dependency to setup.cfg and regenerated requirements-doc.txt by freezing the doc environment. Approved by two reviewers with passing CI across seven files. | |
| #513 build(docs): fix double build with docs-lint | starbase | merged | Merged a one-line fix resolving a double build issue during docs-lint by correcting a mistaken assumption about Sphinx's linter requirements. Approved by two reviewers, passed CI, and closed issue #512. | |
| #4766 docs: use canonical-sphinx | snapcraft | merged | Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks. | |
| #249 docs: use canonical-sphinx extension | craft-cli | merged | Merged following approval by two reviewers. The change integrates the canonical-sphinx extension into the documentation build system, updating 22 files and removing over 1000 lines of legacy configuration. | |
| #2323 build(docs): add sphinx sitemap | charmcraft | merged | Merged following approval from two reviewers. Integrated sphinx-sitemap as a documentation dependency, updated conf.py to generate a sitemap during builds, and switched local builds to the dirhtml builder. |