← Back to issue list

Update documentation to the official Canonical template

View original Github issue

Metadata

Project
craft-cli
Number
#187
Type
issue
State
closed
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

Docs were migrated to Canonical’s sphinx-docs-starter-pack, removing PDF output and replacing the custom Read the Docs setup in commit 77a3b26.

Resolution: closed resolved

Reason: Commit 77a3b26 explicitly adopted Canonical’s sphinx-docs-starter-pack, matching the requested template migration; commit cd48e13 later completed the move to canonical-sphinx.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done Update our docs to the official Canonical template. We can drop the PDF output in the process. ### Why it needs to get done For consistency! Also the readthedocs integration is broken.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Docs were migrated to Canonical’s sphinx-docs-starter-pack, removing PDF output and replacing the custom Read the Docs setup in commit 77a3b26.
stealth/space-bunny-alpha — closed stale Documentation was to adopt Canonical's template, drop PDF output, and repair Read the Docs; #187 closed with no linked PR, commit, or implementation.
qwen/qwen3.6-35b-a3b — — Closed without a linked resolution or merge, likely abandoned. The request to update documentation to the official Canonical template and remove PDF output was not implemented.
qwen/qwen3.6-35b-a3b — — Closed without implementation or follow-up. The documentation update to the official Canonical template and PDF output removal was abandoned.
qwen/qwen3.6-35b-a3b — — Closed without a linked fix or merge. The documentation update to the Canonical template and readthedocs fix were abandoned or completed externally, as no resolution details or follow-up comments were provided.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
72%
#197 chore: use Canonical's sphinx-docs-starter-pack craft-cli merged Merged PR #197 (77a3b26) adopted Canonical's Sphinx starter pack, moved documentation dependencies to a requirements file, and fixed #187.
71%
#209 docs: use canonical-sphinx starbase merged Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx.
71%