some general docs improvements
Metadata
Current evaluation
Merged in canonical/starbase#24, adding Sphinx linting and autobuild, strict docs builds, Ubuntu-font CSS, and renamed docs tox environments.
Resolution: closed resolved
Reason: PR #24 was approved and merged. Its commits added sphinx-lint (cd2832b), warnings-as-errors builds (ec396df), sphinx-autobuild (34e0222), tox environment renames (dbd1b1d), and Ubuntu-font CSS (130845c).
Evaluated by: mr-cal-bot
No scores available.
Issue body
The changes are all doc-related and are split over separate commits:
- add `sphinx-lint` in standard linting
- add css to use the Ubuntu font (css from rockcraft)
- tentatively treat warnings as errors in sphinx-build. If it becomes too onerous projects can remove the flag, but it's the kind of thing where it's easier to have from the beginning
- add `sphinx-autobuild` to have the interactive server when editing the docs
- rename the tox envs to `docs-build` and `docs-autobuild` to keep consistent with the other envs; this one I did mostly out of "pedantry" but we can drop if we decide to keep things as-is.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/starbase#24, adding Sphinx linting and autobuild, strict docs builds, Ubuntu-font CSS, and renamed docs tox environments. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/starbase#24, adding Sphinx lint/autobuild, Ubuntu font CSS, warnings-as-errors docs builds, and consistent docs tox environments. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/starbase#24: added Sphinx linting and autobuild, Ubuntu font CSS, warnings-as-errors builds, and renamed docs tox environments. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/starbase#24, adding sphinx-lint, Ubuntu font CSS, warnings-as-errors builds, sphinx-autobuild, and renamed docs-build/docs-autobuild tox environments. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged documentation tooling improvements: added sphinx-lint, Ubuntu-font CSS, warnings-as-errors, sphinx-autobuild, and renamed tox environments to docs-build and docs-autobuild. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged docs tooling improvements: sphinx-lint, Ubuntu font CSS, sphinx warnings as errors, sphinx-autobuild, and tox env renames to docs-build/docs-autobuild. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation improvements including sphinx-lint integration, Ubuntu font CSS, sphinx-build warning-as-error flag, sphinx-autobuild addition, and tox environment renaming for consistency. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #537 build(docs): update Sphinx Stack to 2.0 | starbase | merged | Merged in canonical/starbase#537 (commit fafd1fc), upgrading docs to Sphinx Stack 2.0, locking dependencies, removing Starter Pack references, and stopping autobuild loops. | |
| #296 docs: add doc tooling and layout from starbase | craft-providers | merged | Merged PR #296 as commit 1e16ba5, adding documentation tox targets, a Diátaxis layout, README.rst, HACKING.rst, and minor reformatting. | |
| #434 docs: use tox for sphinx docs | craft-parts | closed | Closed unmerged as redundant: canonical/craft-parts#433 merged the broader Starbase tox setup in 7dbf0405; equivalent Sphinx support landed via canonical/snapcraft#4273 at d25b49d63. | |
| #4055 docs: import Sphinx scaffolding for documentation work | snapcraft | merged | Merged as commit ebc549ed4 ("docs: import Sphinx scaffolding for documentation work (#4055)"), adding Starbase-derived Sphinx docs scaffolding (docs/conf.py, tox docs config, 13 files, +513 lines). | |
| #493 fix(build): false lint errors | starbase | merged | Merged in canonical/starbase#493 via commit b304e0a, fixing false lint errors by ignoring .sphinx and separating sphinx-lint arguments; all CI checks passed. | |
| #497 build(docs): update Sphinx Stack to 2.0 | craft-cli | merged | Merged PR updating documentation tooling to Sphinx Stack 2.0, migrating from .sphinx to docs/_dev, updating conf.py and Makefile, and adding new documentation files. Upstreamed from canonical/starbase#537. | |
| #398 docs: add linkcheck to doc checks | starbase | merged | Merged in canonical/starbase#398 as d240af2, adding Sphinx linkcheck to documentation checks after the scope was narrowed to linkcheck only. | |
| #5 base: Align to latest starbase standards | craft-archives | merged | PR merged as commit c9e2971: pulled updated config from starbase into craft-archives, adding tox Sphinx/docs setup (no doc files yet) plus lint fixes; later synced again via 071d217 and 0872a9c. |