docs: bring all starter pack documentation checks into tox
Metadata
Current evaluation
Enhancement to integrate Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into tox. Related issue craft-store#105 closed because project is moving away from tox.
Suggested action: close stale
Reason: The related issue craft-store#105 with the identical title was closed because the maintainer stated the project is moving away from tox, making this request no longer applicable. This issue is 1064 days old with no maintainer engagement, and the core premise (using tox for CI) is no longer relevant to the project.
Impact:
15
Quick Win:
12.0
Staleness:
75
Complexity:
20
Confidence:
70
Support Request:
10
Issue body
### What needs to get done
Context: https://github.com/canonical/craft-store/pull/104/files/0e3d99995f1424281837cafa1a8152ac0f90866d#r1349033443
Canonical's [Sphinx docs starter pack](https://github.com/canonical/sphinx-docs-starter-pack) uses several linters we should include:
* Woke (with Canonical's inclusive-naming configuration)
* linkcheck
* pyspelling
Ensure we use their configuration as well.
See: https://github.com/canonical/starbase/issues/136
### Why it needs to get done
If we use tox for all our CI stuff, we won't have CI surprises.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen3.6-35b-a3b-mtp-q6 |
Impact:
15
Quick Win:
12.0
Staleness:
75
Complexity:
20
Confidence:
70
Support Request:
10
|
close stale | Enhancement to integrate Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into tox. Related issue craft-store#105 closed because project is moving away from tox. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
70
Complexity:
15
Confidence:
75
Support Request:
0
|
keep open | Enhancement to integrate Sphinx docs starter pack linters (woke, linkcheck, pyspelling) into tox for consistent CI. Open for ~3 years with no maintainer comments but remains a valid, scoped improvement. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
20
Confidence:
70
Support Request:
0
|
needs triage | Enhancement to integrate Sphinx docs starter pack linters into tox for consistent CI. Open for nearly three years with no maintainer comments, assignees, or prioritization. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
25
Confidence:
70
Support Request:
5
|
needs triage | Enhancement to integrate Sphinx documentation linters into tox for consistent CI. Open for nearly three years with no maintainer comments or prioritization. |
Update history
No update history recorded yet.
Related work
-
Duplicate Of:
craft-store#105
(confidence 90%)
Identical title and scope; craft-store#105 was closed because the project is moving away from tox
-
Related To:
starbase#136
(confidence 80%)
Same starter pack linters were integrated into starbase's docs lint process via PR #478
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #105 docs: bring all starter pack documentation checks into tox | craft-store | closed | Abandoned after maintainer confirmed the project is moving away from tox, leaving the documentation linter consolidation unimplemented. | |
| #136 docs: bring all starter pack documentation checks into docs lint | starbase | closed | Integrated Canonical Sphinx docs starter pack linters (Woke, linkcheck, pyspelling) into the documentation lint workflow. Resolved and merged via pull request #478. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged documentation refactoring to align with sphinx-starter-pack. Approved by three reviewers and passed CI. Modified 28 files (+351/-63) to standardize structure, validate with pylint, shellcheck, and sphinx, and simplify future integration. | |
| #434 docs: use tox for sphinx docs | craft-parts | closed | Closed without review or merge, indicating abandonment. The PR proposed switching Sphinx documentation builds to tox, altering 12 files. No comments, reviewers, or CI checks were recorded. |