← Back to issue list

docs: update to canonical-sphinx

View original Github issue

Metadata

Project
craft-providers
Number
#562
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR was approved and merged into the main branch as commit 9897239, adding the canonical-sphinx extension to docs/conf.py and deleting the sphinx-docs-starter-pack submodule and its references (.gitmodules last touched by this commit). The follow-up PR #713 removed the leftover submodule directory to avoid pip build errors.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This one has multiple commits; the first one enables the extension and then I went a bit delete-happy and removed the sphinx-docs-starter-pack submodule (and references to it). My reasoning is that our repos are getting very confusing with regards to the docs - the starter pack has its own requirements files and other stuff that we no longer use, but it's hard to tell that at-a-glance. I can drop the excess commits if we feel it's too much

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
qwen/qwen3.6-35b-a3b — closed resolved Merged PR updating documentation to use canonical-sphinx and removing the sphinx-docs-starter-pack submodule to simplify the repo.

Update history

Date Change
created

Related work

  • Likely Fixed By: canonical/craft-providers#713 (confidence 92%)

    Follow-up merged PR that deleted the leftover sphinx-docs-starter-pack submodule directory and .gitmodules entry left behind after #562, which was causing pip build errors.

  • Related To: canonical/craft-providers#417 (confidence 70%)

    Earlier PR b9d7aa2 'feat(docs): use canonical starter pack' introduced the sphinx-docs-starter-pack submodule that #562 subsequently removed.

  • Related To: canonical/craft-application#325 (confidence 60%)

    Sibling craft repo migration to canonical-sphinx following the same migration pattern, indicating a cross-repo docs standardisation effort.

  • Related To: canonical/snapcraft#4272 (confidence 55%)

    Analogous removal of the obsolete sphinx-docs-starter-pack submodule entry from .gitmodules in the snapcraft repo.

Related issues

Issue Project State Summary Similarity
#720 docs: use canonical-sphinx craft-parts merged Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files.
85%
#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.
83%
#135 docs(deps): update canonical-sphinx craft-archives merged Merged PR #135 updated the canonical-sphinx documentation dependency in commit 8a38995 after two approvals.
80%
#63 build(deps): update canonical-sphinx craft-platforms merged Merged craft-platforms PR #63 as commit 95ef92b, updating the canonical-sphinx dependency. The author linked canonical-sphinx#50 for the upstream dependency changes.
80%
#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.
79%
#249 docs: use canonical-sphinx extension craft-cli merged Merged PR #249 adopted the canonical-sphinx extension, removing 1,134 lines of legacy documentation configuration.
79%
#209 docs: use canonical-sphinx starbase merged Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx.
78%
#106 docs: use canonical-sphinx craft-archives merged Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6.
77%
#923 build(deps): update dependency canonical-sphinx to ~=0.6.0 (main) craft-providers merged Renovate dependency bump of canonical-sphinx from ~=0.5.1 to ~=0.6.0 was merged into craft-providers main via commit dc895c4 (PR #923), approved by 3 reviewers with all CI checks green.
77%
#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.
76%