Skip to content

Drop custom MrDocs from CI - #806

Merged
sdebionne merged 2 commits into
boostorg:developfrom
sdebionne:drop-custom-mrdocs-from-ci
Sep 7, 2026
Merged

sdebionne merged 2 commits into
boostorg:developfrom
sdebionne:drop-custom-mrdocs-from-ci

Conversation

@sdebionne

Copy link
Copy Markdown
Contributor

Description

The documentation fails to build at the master project level:

develop dashboard link: https://www.boost.org/library/develop/gil/
master dashboard link: https://www.boost.org/library/master/gil/

Try to fix this by sticking to the template set by redis/url... projects.

Unfortunately, AFAIU, to actually test this, it needs to be merged (blindly) to develop.

Tasklist

  • Ensure all CI builds pass
  • Review and approve

sdebionne and others added 2 commits September 7, 2026 13:12
MrDocs 2026.9.4 (official, non-prerelease release) fixes the segfault on
GIL's CRTP-based headers that motivated pinning a personal build.

The other bug that motivated it -- reference pages linking to
private-member sub-pages MrDocs never emits -- is still open upstream
(github.com/cppalliance/mrdocs/issues/1277). Oddly, GIL's specific repro
from that issue passes cleanly against the tagged 2026.9.4 release binary
itself, but fails again against the current `develop` tip (one commit
newer) -- so this is unresolved/regressed, not fixed, regardless of that
one data point.

- docs-prerequisites / generate-doc: back to plain actions/setup-node@v4
  + `bash build_antora.sh`, matching boostorg/url, redis and graph -- no
  cppalliance GitHub Action exists for MrDocs itself (it's resolved by the
  @cppalliance/antora-cpp-reference-extension npm package, not an Action),
  so this is the standard pattern other Boost libraries already use.
- pixi.toml: drop the sdebionne/label/esrf-bcu channel and the mrdocs
  dependency; keeps Node + a C++ compiler for local `pixi run -e docs
  docs-build`, per request pixi itself stays for local dev.
- build_antora.sh: drop the MRDOCS_ROOT/CONDA_PREFIX detection block.

One deliberate remaining guard: local-playbook.yml keeps
`failure_level: fatal` rather than `error`. Beyond #1277 itself, the
extension's release selection always considers cppalliance/mrdocs'
rolling `develop`/`master` tags (verified in its source:
`allowMaster`/`allowDevelop` are hardcoded to `true` regardless of
config, so a `version:` pin can't exclude them), so the exact MrDocs
build used here isn't actually pinned and can vary from run to run.
`fatal` keeps that class of cosmetic dangling-xref noise from
hard-failing the build while still catching a real extraction failure.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Leftover from the interim-Doxygen phase of the MrDocs migration and never
updated when MrDocs replaced it -- doxyfile doesn't even exist anymore.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.85%. Comparing base (c889bcb) to head (1b86699).
⚠️ Report is 33 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #806   +/-   ##
========================================
  Coverage    82.85%   82.85%           
========================================
  Files          119      119           
  Lines         5634     5634           
========================================
  Hits          4668     4668           
  Misses         966      966           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sdebionne
sdebionne marked this pull request as ready for review September 7, 2026 11:57
@sdebionne
sdebionne requested a review from mloskot September 7, 2026 11:57
@sdebionne

Copy link
Copy Markdown
Contributor Author

The exact issue is seen here:
https://www.boost.org/doc/libs/develop/libs/gil/doc/index.html/

image

@sdebionne
sdebionne merged commit 942ec47 into boostorg:develop Sep 7, 2026
31 checks passed
@sdebionne
sdebionne deleted the drop-custom-mrdocs-from-ci branch September 7, 2026 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant