← Back to issue list

docs: update sphinx theme

View original Github issue

Metadata

Project
snapcraft
Number
#4367
Type
pull request
State
merged
Author
sergiusens
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR was approved by 3 reviewers and merged into main as commit aa64666ef ("docs: update sphinx theme (#4367)"). @lengau and @mr-cal confirmed the docs build failures were resolved by mr-cal's #4375, whose changes were folded into the final commits (d3409020) before merge.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [ ] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint`? - [ ] Have you successfully run `pytest tests/unit`? ----- Replaces #4263

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged as aa64666ef, updating the Sphinx documentation theme and incorporating fixes from #4375 to restore documentation builds.
stealth/space-bunny-alpha — closed resolved Merged the Sphinx theme update into main via #4367 (aa64666ef), incorporating #4375’s documentation-build fix.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged after replacing PR #4263. Documentation build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. The Sphinx theme update was successfully integrated into main.

Update history

No update history recorded yet.

Related work

  • Superseded By: snapcore/snapcraft#4263 (confidence 92%)

    PR body states "Replaces #4263"; #4263 was closed unmerged, so this PR is the surviving implementation of the Sphinx theme update.

  • Likely Fixed By: snapcore/snapcraft#4375 (confidence 90%)

    Comment from @lengau: "I think @mr-cal's PR #4375 got it" — #4375 fixed the tox build-docs/lint-docs failures introduced by the theme update, and its changes were merged into this branch.

Related issues

Issue Project State Summary Similarity
#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.
87%
#4263 docs: update Sphinx theme snapcraft closed Closed unmerged; theme work moved through #4264, and a later Sphinx theme update landed via #4367 (commit aa64666ef).
86%
#73 docs: update sphinx to 6 starbase merged Merged via f4f5541, updating the documentation dependency to Sphinx 6 as an intermediate step; Furo#653 still blocked Sphinx 7.
76%
#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.
75%
#135 docs(deps): update canonical-sphinx craft-archives merged Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals.
74%
#209 docs: use canonical-sphinx starbase merged Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx.
74%
#106 docs: use canonical-sphinx craft-archives merged Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6.
74%
#65 docs: fix sphinx doc generation and update docstrings craft-parts merged Merged in canonical/craft-parts#65 via a5373f23, fixing Sphinx type-hint import cycles and adding missing docstring parameter descriptions.
73%
#562 docs: update to canonical-sphinx craft-providers merged Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713.
73%
#5559 build(docs): update build, add sphinx sitemap, add feedback button snapcraft merged Merged docs build overhaul adding feedback, a Sphinx sitemap, dirhtml, consistent RTD tooling, and housekeeping; landed as commit 24f5da833 (#5559).
72%