← 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 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.

Suggested action: needs triage

Reason: No labels, no maintainer response, no assignee, and 482 days of inactivity indicate this was never triaged. The current docs/conf.py run_apidoc excludes *dispatcher* from API docs generation, which would eliminate the duplicate craft_cli.dispatcher.CommandGroup / craft_cli.dispatcher.BaseCommand targets and likely resolve the warnings — but this needs a maintainer to confirm by running the RTD build before closing.

Impact: 15 Quick Win: 12.0 Staleness: 75 Complexity: 20 Confidence: 55 Support Request: 5

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
qwen/qwen3.8-27b
Impact: 15
Quick Win: 12.0
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 75
Complexity: 10
Confidence: 85
Support Request: 0
needs triage Resolve ReadTheDocs build warnings from ambiguous docstring cross-references for CommandGroup and BaseCommand. Open for over a year with zero comments, awaiting triage or assignment to ensure predictable documentation builds.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.