← Back to issue list

docs: bring all starter pack documentation checks into tox

View original Github issue

Metadata

Project
craft-providers
Number
#420
Type
issue
State
open
Author
lengau
Labels
Type: Enhancement
Created
Updated
Closed
—

Current evaluation

Starter-pack documentation checks now run through the Make/uv docs-lint workflow; tox was removed, making the request to integrate them into tox obsolete.

Suggested action: close stale

Reason: Commit 6f78e1a (#310) removed tox.ini, so the requested integration target no longer exists. The current common.mk docs-lint target already runs spelling, woke, and linkcheck, with pyspelling configuration in docs/spellingcheck.yaml and Canonical inclusive-language configuration in docs/Makefile.

Evaluated by: mr-cal-bot

Impact: 15 Quick Win: 11 Complexity: 20 Confidence: 96 Actionability: 90

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
stealth/space-bunny-alpha
Impact: 15
Quick Win: 11
Complexity: 20
Confidence: 96
Actionability: 90
close stale Starter-pack documentation checks now run through the Make/uv docs-lint workflow; tox was removed, making the request to integrate them into tox obsolete.
stealth/space-bunny-alpha
Impact: 43
Quick Win: 22
Complexity: 38
Confidence: 86
Actionability: 84
needs triage Maintainer-authored enhancement remains untriaged: consolidate all Sphinx starter-pack documentation checks under tox, including Woke, linkcheck, and pyspelling.
qwen3.6-35b-a3b-mtp-q6
Impact: 15
Quick Win: 12
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.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#136 (confidence 100%)

    Explicitly cited by this issue and completed through Starbase PR #478.

  • Superseded By: canonical/starbase#478 (confidence 96%)

    The merged Starbase docs-lint work added Woke, linkcheck, and pyspelling using the starter-pack configuration.

  • Related To: canonical/craft-store#105 (confidence 95%)

    The parallel issue was closed as unnecessary because Starbase was moving away from tox.

Related issues

Issue Project State Summary Similarity
#105 docs: bring all starter pack documentation checks into tox craft-store closed Documentation checks were not added to tox; the maintainer closed the work after announcing that craft-store was moving away from tox.
85%
#136 docs: bring all starter pack documentation checks into docs lint starbase closed Added Canonical Starter Pack checks for Woke, linkcheck and spelling, wiring them into docs-lint via merged PR #478 (commit e94f190).
72%