feat: add basic sphinx docs
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged by maintainer lengau, the change adds a Sphinx documentation project to automate reference generation for juju.is. It integrates the starbase Sphinx setup, a rockcraft command generator, and updates pydantic models to sync documentation, resolving issue #1692. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #12 docs: Basic sphinx docs | starbase | merged | Merged basic Sphinx documentation adding 208 lines across 10 files. Approved by one reviewer and merged despite three unresolved comments. A noted test failure was resolved in PR #13. | |
| #24 some general docs improvements | starbase | merged | Merged documentation improvements adding sphinx-lint, Ubuntu font CSS, warning-as-error configuration, sphinx-autobuild, and renamed tox environments. Approved by one reviewer and successfully merged. | |
| #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). | |
| #501 docs: update Sphinx theme | craft-parts | merged | Updated Sphinx documentation theme. Merged after single reviewer approval and passing CI checks. Changed seven files with 151 additions and 20 deletions. | |
| #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. | |
| #65 docs: fix sphinx doc generation and update docstrings | craft-parts | merged | Merged after two approvals and passing CI. Fixed Sphinx doc generation by importing modules to resolve import cycles, and added missing parameter descriptions to docstrings across five files. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged documentation update for the Sphinx theme. Initial build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. Approved by three reviewers, passed CI, and merged into main. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged documentation refactoring to align with sphinx-starter-pack. Approved by three reviewers and passed CI. Modified 28 files (+351/-63) to standardize structure, validate with pylint, shellcheck, and sphinx, and simplify future integration. | |
| #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. |