← 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

An open documentation-maintenance request proposes auditing Sphinx dependencies and simplifying requirements, but it remains broad, untriaged, and unresolved.

Suggested action: needs triage

Reason: The repository still maintains a curated docs/requirements.txt, and docs/conf.py explicitly loads sphinx-autodoc-typehints, so dependency removal requires a usage and build audit. Although labeled Type: Documentation, the issue has zero comments, no concrete dependency inventory or acceptance criteria, and only an external PR discussion as context, so it needs maintainer triage rather than closure.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 5 Complexity: 52 Confidence: 82 Actionability: 44

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
stealth/space-bunny-alpha
Impact: 25
Quick Win: 5
Complexity: 52
Confidence: 82
Actionability: 44
needs triage An open documentation-maintenance request proposes auditing Sphinx dependencies and simplifying requirements, but it remains broad, untriaged, and unresolved.
stealth/space-bunny-alpha
Impact: 12
Quick Win: 3
Complexity: 20
Confidence: 82
Actionability: 35
close resolved Documentation-dependency audit (drop sphinx-autodoc, align with sphinx-starter-pack pinned requirements). Superseded by the sphinx-starter-pack refresh of docs/requirements.txt and docs/conf.py.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 5
Complexity: 20
Confidence: 60
Actionability: 30
needs triage Discussion on auditing and refactoring documentation build dependencies, specifically evaluating the necessity of sphinx-autodoc and potential alignment with sphinx-starter-pack.
qwen/qwen3.8-27b
Impact: 15
Quick Win: 12
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.

Update history

No update history recorded yet.

Related work

  • Related To: rockcraft#300 (confidence 100%)

    The issue body explicitly cites the discussion comment in pull request #300 as the source of the request.

  • Related To: rockcraft#1112 (confidence 85%)

    Commit 61e6bf3a, titled build(docs): refresh starter pack implementation, is directly related to the proposed starter-pack refactor, but does not establish that this issue was closed.

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

    Commit caf0486f, titled docs: update dependency sphinx stack to 2.0, touched documentation dependencies, but no explicit resolution link was found.

Related issues

No related issues found above the similarity threshold.