Skip to content

doc builder: Improve verbosity filter#3994

Merged
samsrabin merged 1 commit into
ESCOMP:b4b-devfrom
samsrabin:doc-builder-improve-verbosity-filter
May 5, 2026
Merged

doc builder: Improve verbosity filter#3994
samsrabin merged 1 commit into
ESCOMP:b4b-devfrom
samsrabin:doc-builder-improve-verbosity-filter

Conversation

@samsrabin
Copy link
Copy Markdown
Member

@samsrabin samsrabin commented May 5, 2026

Description of changes

Resolves issues @slevis-lmwg experienced here:

  • CRITICAL messages from Sphinx build were getting filtered out in non-verbose mode
  • Spurious warning message about image platform not matching expected was not getting filtered out.

This led to it seeming like the image platform thing was the problem.

The new version of doc-builder, when not verbose:

  • Includes CRITICAL messages
  • Suppresses "image platform does not match expected" warning

So before:

Cleaning documentation build directory...
Done.
Building documentation...
WARNING: The requested image's platform (linux/amd64/v8) does not match the detected host platform (linux/amd64/v3) and no specific platform was requested
Documentation build completed, but with problems that must be resolved.
Re-run with --verbose for full output.

After:

Cleaning documentation build directory...
Done.
Building documentation...
/home/user/mounted_home/doc/source/tech_note/FUN/CLM50_Tech_Note_FUN.rst:4: CRITICAL: Duplicate ID: "equation-n-cost-fix". [docutils]
Documentation build completed, but with problems that must be resolved.
Re-run with --verbose for full output.

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed (include github issue #): None

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? No

Does this create a need to change or add documentation? Did you do so? No

Testing performed, if any: Manual testing.

When not verbose:
- Capture `CRITICAL` messages
- Suppress "image platform does not match expected" warning
@samsrabin samsrabin changed the base branch from master to b4b-dev May 5, 2026 22:05
@samsrabin samsrabin self-assigned this May 5, 2026
@samsrabin samsrabin added b4b bit-for-bit documentation additions or edits to user-facing documentation or its infrastructure docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure size: small labels May 5, 2026
Copy link
Copy Markdown
Contributor

@slevis-lmwg slevis-lmwg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @samsrabin.

@samsrabin samsrabin merged commit c9fbe28 into ESCOMP:b4b-dev May 5, 2026
11 checks passed
@slevis-lmwg slevis-lmwg mentioned this pull request May 7, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

b4b bit-for-bit docs:infrastructure New features or bug fixes in the documentation infrastructure docs-loc:infrastructure Relates to documentation infrastructure documentation additions or edits to user-facing documentation or its infrastructure size: small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants