Set up reference documentation with Sphinx
Metadata
Current evaluation
Sphinx reference docs were added by merged PR #1711 in commit b48ef739, including generated command and model references.
Resolution: closed resolved
Reason: PR #1711 was merged as b48ef739 and explicitly fixes #1692, adding basic Sphinx documentation, command references, and model references.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### What needs to get done
Create an RTD project and set up sphinx.
- Home page
- Autogenerated reference
- command help, one command per page
- Project Model references
### Why it needs to get done
So we can link to auto-generated documentation from docs.charmhub.io
cc @tmihoc
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Sphinx reference docs were added by merged PR #1711 in commit b48ef739, including generated command and model references. | |
| stealth/space-bunny-alpha | — | closed stale | Closed without a documented Sphinx/RTD implementation or linked resolving PR or commit. | |
| stealth/space-bunny-alpha | — | closed stale | Closed without a documented Sphinx/RTD implementation or linked PR; the sole comment was an automated notice creating internal ticket CRAFT-2981. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without implementation. No resolution or merge details were provided. A Jira sync comment indicates tracking as CRAFT-2981. The task appears abandoned or superseded. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed and superseded by internal Jira ticket CRAFT-2981. The Sphinx documentation setup was migrated off GitHub for tracking, with no implementation or merges recorded. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without implementation. The Sphinx and RTD documentation setup request was synced to Jira ticket CRAFT-2981 but received no technical resolution, indicating it was abandoned or superseded. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without resolution. Tracking was moved to Jira ticket CRAFT-2981. No implementation or merge details were provided. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without implementation. The Sphinx documentation setup was tracked internally via Jira ticket CRAFT-2981, with no code changes or merge recorded. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/charmcraft#1711
(confidence 100%)
Merged PR explicitly identifies #1692 as fixed.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1711 feat: add basic sphinx docs | charmcraft | merged | Merged PR #1711 as b48ef739, adding Sphinx docs, generated command references, and juju.is model documentation; fixes #1692. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. |