docs: compile every documentation code block#373
Conversation
|
An automated preview of the documentation is available at https://373.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-07-23 21:36:57 UTC |
|
GCOVR code coverage report https://373.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-07-23 21:52:51 UTC |
Replace all ~480 hand-typed [source,cpp] blocks across the 45 doc pages with includes of compiled sources, so an example that breaks can no longer render on the site. - test/doc/snippets: one TU per page; fragments compile and run as test suites with assertions on the behavior the prose claims - test/doc/programs: complete teaching programs, run by exit code; bug demos (races, deadlocks) are built but never executed - example/: tagged regions replace duplicated excerpts on the 15 example pages - @antora/collector-extension, registered in the library's own playbook, scans example/ and test/doc into the Antora examples family so pages use include::example$...[tag=...] without symlinks or duplication - Blocks that intentionally do not compile are explicit: rejected or sketch-level designs carry role=pseudocode (21), other-library comparisons carry role=external (13) test/tsan.supp suppresses reports from Apple libc++ stream internals, which lack TSan annotations for the concurrent std::cout the standard requires to be race-free.
809cb17 to
fc17a67
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #373 +/- ##
===========================================
+ Coverage 98.07% 98.09% +0.01%
===========================================
Files 132 132
Lines 6230 6288 +58
===========================================
+ Hits 6110 6168 +58
Misses 120 120
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
2 participants
Replace all ~480 hand-typed [source,cpp] blocks across the 45 doc pages with includes of compiled sources, so an example that breaks can no longer render on the site.
test/tsan.supp suppresses reports from Apple libc++ stream internals, which lack TSan annotations for the concurrent std::cout the standard requires to be race-free.