Skip to content

Fix Docs & Silence Output - #264

Merged
zfergus merged 5 commits into
mainfrom
fix/quite-docs-build
Sep 16, 2026
Merged

zfergus merged 5 commits into
mainfrom
fix/quite-docs-build

Conversation

@zfergus

@zfergus zfergus commented Sep 16, 2026

Copy link
Copy Markdown
Member

No description provided.

zfergus and others added 5 commits September 15, 2026 16:24
- Pass -q to Sphinx and Doxygen so only warnings and errors reach the
  console; a clean build drops from 3159 lines of stdout to none
- Swallow the two bare print() calls that -q cannot reach, from the
  ipctk finder and the theme's sitemap generator
- Spin a stage line naming what is running, since a silent half-minute
  is indistinguishable from a hung build
- Wrap Sphinx's own warning handler so warnings never land mid-frame;
  swapping sys.stderr is too late, as the stream binds at startup
- Limit the spinner to interactive terminals, leaving redirected output
  and CI byte-for-byte as quiet as before
- Set DOCS_VERBOSE=1 to restore the full log
- Check Doxygen's exit status, which the old truthiness test on the
  CompletedProcess could never detect

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- Give each group in normal.hpp its own id, and close the line-line
  group inside the namespace that opened it
- Rewrite parameter docs in point3.hpp and smooth_collisions.hpp that
  still described earlier signatures
- Document the parameters that were missing in the broad phase, spatial
  hash, and smooth contact potential headers
- Name the unused point-point hessian parameters so their docs resolve
- Expand IPC_TOOLKIT_HOST_DEVICE away so Sphinx can parse the
  signatures; 22 functions were missing from the docs entirely
- Write matrix dimensions as |F| rather than #F, which Doxygen read as
  a link to an entity named F
- Hide the fmt::formatter specialization, whose scope Doxygen cannot
  resolve because it never parses fmt's headers
- Drop an @InGroup naming a group that is never defined
- Raise DOT_GRAPH_MAX_NODES past the largest graph the build produces
@zfergus
zfergus merged commit 869e489 into main Sep 16, 2026
17 checks passed
@zfergus
zfergus deleted the fix/quite-docs-build branch September 16, 2026 15:53
@codecov

codecov Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.92%. Comparing base (3817e4a) to head (43b5f28).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #264   +/-   ##
=======================================
  Coverage   96.92%   96.92%           
=======================================
  Files         194      194           
  Lines       17349    17349           
  Branches      944      943    -1     
=======================================
  Hits        16816    16816           
  Misses        533      533           
Flag Coverage Δ
unittests 96.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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