docs: import Sphinx scaffolding for documentation work
Metadata
Current evaluation
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).
Resolution: closed resolved
Reason: The PR was merged into snapcraft as commit ebc549ed4 after approval from lengau, importing the Starbase Sphinx scaffolding (docs/conf.py, tox docs target). Follow-up comments noted the spread test failure was resolved by #4102.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint`?
- [x] Have you successfully run `pytest tests/unit`?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | 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). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as ebc549ed4, adding 13 files of Sphinx documentation scaffolding, including tox configuration and the python-apt docs dependency. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged after review approval and passing CI checks. Imports Sphinx scaffolding for documentation, includes the requested tox configuration, and resolves the missing python-apt dependency for the docs build. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged into main. Imported Sphinx scaffolding for documentation, added tox configuration, resolved missing python-apt dependency for the docs target, and deferred spread test fix to follow-up PR #4102. |
Update history
No update history recorded yet.
Related work
-
Related To:
snapcraft#4102
(confidence 88%)
Comment by lengau states the spread test failure in this PR would be fixed once #4102 (spread host storage bump, commit 2868dd12c) merged.
-
Related To:
canonical/starbase#12
(confidence 70%)
Upstream Starbase 'docs: Basic sphinx docs' PR is the source of the scaffolding imported here.
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. | |
| #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. | |
| #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. | |
| #163 docs: use Sphinx + Readthedocs | fetch-service | merged | Merged #163, migrating the documentation to a canonical-sphinx-based Sphinx project and connecting it to Read the Docs builds. | |
| #24 some general docs improvements | starbase | merged | Merged in canonical/starbase#24, adding Sphinx linting and autobuild, strict docs builds, Ubuntu-font CSS, and renamed docs tox environments. | |
| #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. | |
| #501 docs: update Sphinx theme | craft-parts | merged | Merged as ed49f727, updating the Sphinx theme and documentation configuration; follow-up #502 (fd11dddc) repaired tox documentation builds. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. | |
| #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. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged as commit aa64666ef, updating the Sphinx documentation theme; it replaced earlier attempt #4263 and picked up the #4375 fixes that restored broken doc builds. |