← Back to issue list

docs: remove starter pack submodule

View original Github issue

Metadata

Project
craft-providers
Number
#713
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged docs cleanup PR deleting the leftover sphinx-docs-starter-pack submodule directory (and its .gitmodules entry) left behind after #562 removed the submodule, avoiding pip build errors.

Resolution: closed resolved

Reason: PR #713 by maintainer mr-cal was merged with two approvals and a 1-file, +0/-1 deletion; it removes the stale submodule gitlink left over from merged PR #562, which dropped the sphinx-docs-starter-pack submodule but left the directory on disk.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `tox`? ----- This submodule was [removed](https://github.com/canonical/craft-providers/pull/562/files#diff-fe7afb5c9c916e521401d3fcfb4277d5071798c3baf83baf11d6071742823584) from git in #562 but the directory was left. This PR removes the directory because `pip` gets confused when there is a submodule directory and no entry in `.gitmodules`.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged docs cleanup PR deleting the leftover sphinx-docs-starter-pack submodule directory (and its .gitmodules entry) left behind after #562 removed the submodule, avoiding pip build errors.
qwen/qwen3.6-35b-a3b — closed resolved Merged cleanup PR removing the orphaned starter-pack submodule directory to prevent pip confusion after its initial removal in #562.

Update history

Date Change
created

Related work

  • Related To: canonical/craft-providers#562 (confidence 92%)

    Merged PR that originally removed the sphinx-docs-starter-pack submodule from .gitmodules but left the directory, which #713 cleans up.

Related issues

Issue Project State Summary Similarity
#4272 docs: remove obsolete submodule snapcraft merged Merged PR #4272 (commit e57f979ed) removed the obsolete sphinx-docs-starter-pack submodule entry from .gitmodules, deleting 3 lines from one docs-related config file.
87%
#1341 chore: rename starter pack submodule craft-parts merged Merged in #1341 via 1803cfa8, renaming the documentation submodule to sphinx-docs-starter-pack and updating references and contributor resync instructions.
77%
#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.
74%
#275 build(docs): incorporate the latest Sphinx Starter Pack imagecraft merged Merged PR #275 (commit 097e5f5), refreshing the docs build with the latest canonical Sphinx Starter Pack across 23 files; author noted the failing fast-test/build checks were unrelated.
73%
#490 build(deps): remove unused docs dependencies starbase merged Merged in 43c54fa (#490), removing unused documentation dependencies while retaining commented entries until Starter Pack removes them.
72%
#979 chore: rename starter pack submodule rockcraft merged Merged as c6c7879c, renaming the docs Starter Pack submodule to sphinx-docs-starter-pack and documenting contributor resync steps for Rockcraft 1.15.
72%
#300 docs: refactor documentation for sphinx-starter-pack rockcraft merged Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration.
71%