← Back to issue list

Fix all warnings in RTD builds

View original Github issue

Metadata

Project
craft-cli
Number
#342
Type
issue
State
open
Author
bepri
Labels
—
Created
Updated
Closed
—

Current evaluation

RTD has ambiguous cross-reference warnings for CommandGroup and BaseCommand; warning-failure enforcement remains disabled pending closure.

Suggested action: needs triage

Reason: The report provides both exact Sphinx warnings, and the code re-exports these classes from craft_cli.dispatcher, matching the ambiguous targets. .readthedocs.yaml still has fail_on_warning commented out with an explicit note to enable it once #342 closes. The scope is clear, but the issue has no labels, comments, assignee, or other recorded triage.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 21 Complexity: 20 Confidence: 94 Actionability: 86

Issue body

### What needs to get done RTD builds have warnings that are currently being ignored: ``` /home/docs/checkouts/readthedocs.org/user_builds/canonical-craft-cli/checkouts/340/craft_cli/helptexts.py:docstring of craft_cli.helptexts.HelpBuilder:1: WARNING: more than one target found for cross-reference 'CommandGroup': craft_cli.CommandGroup, craft_cli.dispatcher.CommandGroup /home/docs/checkouts/readthedocs.org/user_builds/canonical-craft-cli/checkouts/340/craft_cli/helptexts.py:docstring of craft_cli.helptexts.HelpBuilder.get_command_help:1: WARNING: more than one target found for cross-reference 'BaseCommand': craft_cli.BaseCommand, craft_cli.dispatcher.BaseCommand ``` ### Why it needs to get done For better maintainability and predictability of docs builds

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 21
Complexity: 20
Confidence: 94
Actionability: 86
needs triage RTD has ambiguous cross-reference warnings for CommandGroup and BaseCommand; warning-failure enforcement remains disabled pending closure.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 80
Actionability: 80
keep open RTD build warnings for ambiguous cross-references to CommandGroup and BaseCommand in craft_cli/helptexts.py docstrings; issue is open with no maintainer response after 502 days.
qwen/qwen3.8-27b
Impact: 15
Quick Win: 12
Staleness: 75
Complexity: 20
Confidence: 55
Support Request: 5
needs triage RTD Sphinx build emits 'more than one target found' warnings for CommandGroup and BaseCommand cross-references in helptexts.py docstrings. Filed by maintainer bepri 482 days ago; no labels, comments, or assignee. Current docs/conf.py excludes *dispatcher* from apidoc, which may already resolve the ambiguity, but unverified.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 15
Confidence: 85
Support Request: 5
needs triage ReadTheDocs builds show Sphinx warnings about ambiguous cross-references for CommandGroup and BaseCommand. No maintainer response, labels, or assignee after over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 95
Complexity: 15
Confidence: 85
Support Request: 5
needs triage Resolves ambiguous cross-reference warnings in ReadTheDocs builds for craft_cli. Currently inactive for over a year with no maintainer response, labels, or assignee.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.