Skip to content

ENH: Appearance of documentation console output.#6429

Merged
dzenanz merged 1 commit into
InsightSoftwareConsortium:mainfrom
albert-github:feature/bug_docu_quiet
Jun 10, 2026
Merged

ENH: Appearance of documentation console output.#6429
dzenanz merged 1 commit into
InsightSoftwareConsortium:mainfrom
albert-github:feature/bug_docu_quiet

Conversation

@albert-github

Copy link
Copy Markdown
Contributor

In the overnight documentation build it is now hard to find which warnings doxygen emits as the warning output is mixed with the "progress messages". By setting the doxygen setting QUIET = YES the "progress messages" are not shown anymore.

PR Checklist

In the overnight documentation build it is now hard to find which warnings doxygen emits as the warning output is mixed with the "progress messages".
By setting the doxygen setting `QUIET = YES` the "progress messages" are not shown anymore.
@github-actions github-actions Bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots type:Enhancement Improvement of existing methods or implementation area:Documentation Issues affecting the Documentation module labels Jun 10, 2026
@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR sets DOXYGEN_QUIET = YES in the Doxygen CMake configuration to suppress informational progress messages during documentation builds, making Doxygen warnings easier to identify in overnight CI output.

  • Adds a single set(DOXYGEN_QUIET "YES") line to DoxygenConfig.cmake, grouped with the other top-level Doxygen output settings.
  • No functional change to the generated documentation; only the verbosity of the build console output is affected.

Confidence Score: 5/5

Safe to merge — the change only quiets Doxygen's informational progress output and has no effect on the generated documentation or any other build artifact.

A single-line configuration addition that toggles a well-understood Doxygen verbosity flag. There is no logic change, no new dependency, and no risk of altering the documentation output itself.

No files require special attention.

Important Files Changed

Filename Overview
Utilities/Doxygen/DoxygenConfig.cmake Adds DOXYGEN_QUIET=YES to suppress Doxygen progress messages, making build warnings easier to spot in CI logs.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[CMake configure step] --> B[DoxygenConfig.cmake sets DOXYGEN_QUIET=YES]
    B --> C[doxygen_add_docs invoked]
    C --> D{Doxygen runs}
    D -->|Progress messages| E[Suppressed ✓]
    D -->|Warnings / Errors| F[Printed to console ✓]
    F --> G[CI log — warnings easier to find]
Loading

Reviews (1): Last reviewed commit: "ENH: Appearance of documentation console..." | Re-trigger Greptile

@dzenanz

dzenanz commented Jun 10, 2026

Copy link
Copy Markdown
Member

/azp run ITK.macOS.Python

@dzenanz

dzenanz commented Jun 10, 2026

Copy link
Copy Markdown
Member

ITK.macOS.Python hanged with: Failed to post status to GitHub for repository InsightSoftwareConsortium/ITK with error: "Requires authentication". Verify that the GitHub credentials are still valid on the service connection. For OAuth connections, verify that Azure Pipelines is granted access to the repository's organization

@dzenanz dzenanz merged commit b3f7244 into InsightSoftwareConsortium:main Jun 10, 2026
18 of 19 checks passed
@albert-github albert-github deleted the feature/bug_docu_quiet branch June 11, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Documentation Issues affecting the Documentation module type:Enhancement Improvement of existing methods or implementation type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants