Skip to content

Simplify messaging#37

Merged
samsrabin merged 17 commits intoESMCI:masterfrom
samsrabin:simplify-messaging
Apr 10, 2026
Merged

Simplify messaging#37
samsrabin merged 17 commits intoESMCI:masterfrom
samsrabin:simplify-messaging

Conversation

@samsrabin
Copy link
Copy Markdown
Collaborator

No description provided.

samsrabin and others added 17 commits April 9, 2026 16:36
Implements output_utils.py with extract_sphinx_complaints(), which filters
WARNING/ERROR lines from Sphinx build output. Supports multiple input strings
(e.g., stdout and stderr). This prepares the ground for showing only actionable
lines on build failure when a --verbose flag is added.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Adds the --verbose (-V) flag to commandline_options so callers can
opt into full build output; defaults to False (show only errors/warnings).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Guard build command echo and detailed error output behind --verbose flag.
In non-verbose mode, show only Sphinx WARNING/ERROR lines on failure with
a hint to re-run with --verbose. Extract helper functions to keep
run_build_command within pylint complexity limits.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…eback

In non-verbose mode, the user sees only the filtered complaints and
a hint to re-run with --verbose. The Python traceback is noise in that
context. Verbose mode still raises the exception for full diagnostics.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
When Sphinx reports "build finished with problems" (warnings treated as
errors), show "Documentation build completed, but with problems that must
be resolved." instead of "Documentation build failed." since the HTML
was actually generated.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@samsrabin samsrabin merged commit 243025a into ESMCI:master Apr 10, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant