feat: add basic sphinx docs
Metadata
Current evaluation
Merged PR #1711 as b48ef739, adding Sphinx docs, generated command references, and juju.is model documentation; fixes #1692.
Resolution: closed resolved
Reason: PR #1711 was merged into main at commit b48ef739. It added Sphinx documentation infrastructure and explicitly fixes #1692.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Adds a Sphinx documentation project and some basic documentation. The purpose is to allow automatic generation of certain reference documentation that would otherwise need to be manually generated for juju.is.
This includes using the Starcraft standard `starbase` sphinx docs, A command documentation generator from rockcraft, and additions to some pydantic models to copy documentation out of what's on juju.is.
Fixes #1692
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1711 as b48ef739, adding Sphinx docs, generated command references, and juju.is model documentation; fixes #1692. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as commit b48ef739 by maintainer lengau (approved by 2 reviewers, +1080/-63, 25 files): adds Sphinx/starbase docs, rockcraft-based command reference generator, and juju.is model docstrings, fixing #1692. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #1711 (b48ef739), adding Sphinx reference documentation, Rockcraft command generation, and Juju-site model documentation, fixing #1692. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged to implement a Sphinx documentation project and basic reference docs for auto-generating juju.is content. Approved by two reviewers, resolves #1692, and updates 25 files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged by maintainer lengau, the update introduces a Sphinx documentation project to automate reference docs for juju.is. It integrates the starbase Sphinx setup, a rockcraft command generator, and pydantic model updates. Resolves #1692. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/charmcraft#1692
(confidence 100%)
PR #1711 explicitly states that it fixes the Sphinx reference documentation request in #1692.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1692 Set up reference documentation with Sphinx | charmcraft | closed | Sphinx reference docs were added by merged PR #1711 in commit b48ef739, including generated command and model references. | |
| #12 docs: Basic sphinx docs | starbase | merged | Merged in canonical/starbase#12 via commit 08a1e8d, adding basic Sphinx documentation with 208 lines across 10 files. | |
| #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. |