← Back to issue list

Reflexion about documentation dependencies

View original Github issue

Metadata

Project
rockcraft
Number
#306
Type
issue
State
open
Author
SamirPS
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Docs dependency cleanup task from 2023 asking to rethink sphinx-autodoc and align requirements with sphinx-starter-pack. The docs infrastructure has since been reworked around the Sphinx Stack subproject, making the original premise largely obsolete. No maintainer comments.

Suggested action: close stale

Reason: The docs build was fundamentally reworked: the starter pack became the Sphinx Stack subproject (commits #1112, #1252), docs/requirements.txt was refactored, and the dependency management process now follows the Sphinx Stack model described in docs/README.md. The original question about aligning with sphinx-starter-pack is moot given this architectural change, and the issue has had zero maintainer engagement in 3+ years.

Impact: 15 Quick Win: 12.0 Staleness: 78 Complexity: 20 Confidence: 72 Support Request: 10

Issue body

### What needs to get done Like Tiago said in this comment: https://github.com/canonical/rockcraft/pull/300#discussion_r1243584297 We need to rethink what dependencies we need for the documentation. Do we need ``sphinx-autodoc`` for example? ### Why it needs to get done This will permit us to refactor the documentation requirements file and, in the end, we will maybe only need to use the pinned requirements from the sphinx-starter-pack.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 15
Quick Win: 12.0
Staleness: 78
Complexity: 20
Confidence: 72
Support Request: 10
close stale Docs dependency cleanup task from 2023 asking to rethink sphinx-autodoc and align requirements with sphinx-starter-pack. The docs infrastructure has since been reworked around the Sphinx Stack subproject, making the original premise largely obsolete. No maintainer comments.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 20
Confidence: 85
Support Request: 10
close stale Open discussion on refactoring documentation dependencies and potentially adopting sphinx-starter-pack. Unassigned, zero comments, and inactive for over seven months.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 80
Support Request: 5
close stale Open discussion from over 3 years ago about refactoring documentation dependencies and questioning the need for sphinx-autodoc. Lacks maintainer feedback and has seen no progress.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 20
Confidence: 80
Support Request: 5
needs triage Open discussion about refactoring documentation build dependencies, potentially simplifying them to use sphinx-starter-pack requirements. Currently inactive with no maintainer response or comments.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 15
Confidence: 85
Support Request: 0
close stale Assesses documentation dependencies like sphinx-autodoc to streamline requirements via sphinx-starter-pack. Open, zero comments, awaiting discussion and triage.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: rockcraft#1112 (confidence 65%)

    'build(docs): refresh starter pack implementation' reworked the docs dependency management around the starter pack/Sphinx Stack, addressing the core concern of this issue

  • Related To: rockcraft#1252 (confidence 55%)

    'docs: update dependency sphinx stack to 2.0' further updated the docs dependency stack, continuing the evolution started by this issue

Related issues

Issue Project State Summary Similarity
#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.
73%