doc: remove files left over from pre-Antora doc builds - #88
Merged
Conversation
|
An automated preview of the documentation is available at https://88.openmethod.prtest3.cppalliance.org/libs/openmethod/doc/html/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-08-19 23:35:46 UTC |
The doc directory still carried the hand-written reference pages and the
Asciidoctor assets from the toolchains that preceded Antora and MrDocs.
Antora reads only doc/antora.yml and doc/modules, so none of it was
reachable from the build; a full build before and after these deletions
produces byte-identical output except as noted below.
Removed:
- 29 top-level *.adoc reference pages, superseded by the MrDocs-generated
reference and the pages under doc/modules/ROOT/pages.
- docinfo.html and the zajo-{light,dark}.css it pulls in, copied from
Boost.LEAF (the meta description still advertised "Lightweight Error
Augmentation Framework"), plus rouge-github.css. Antora supplies its own
styling and does not read docinfo files.
- gentags.sh and doc/tagfiles. The antora-cpp-tagfiles extension loads
tagfiles named in ext.cpp-tagfiles.files, which antora.yml does not set,
plus the cppreference tagfile it now bundles itself; gentags.sh wrote to
a file name that was not even present in tagfiles.
- openmethod-theme.yml, an asciidoctor-pdf theme with no PDF build left,
and the unreferenced skin.png and open.png.
Also removed two orphan pages under doc/modules/ROOT/pages. These were in
the nav of no page but Antora publishes pages regardless, so both did
render: error_processing.adoc was empty, and virtual_parameter.adoc was a
stub titled "Macros" whose body showed unconverted Doxygen @ref markup as
literal text. Dropping them removes two URLs from the sitemap and two
entries from the search index.
Kept library-detail.adoc, which is not in the Antora nav but is the Boost
website's library page, and doc/modules/ROOT/images.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
jll63
force-pushed
the
fix/remove-doc-cruft
branch
from
August 19, 2026 23:29
9f07304 to
ee34c19
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #88 +/- ##
========================================
Coverage 94.31% 94.31%
========================================
Files 88 88
Lines 3325 3325
Branches 1579 1579
========================================
Hits 3136 3136
Misses 158 158
Partials 31 31 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
docdirectory still carried the hand-written reference pages and the Asciidoctor assets from the toolchains that preceded Antora and MrDocs. Antora reads onlydoc/antora.ymlanddoc/modules, so none of it was reachable from the build.Removed
*.adocreference pages, superseded by the MrDocs-generated reference and the pages underdoc/modules/ROOT/pages.docinfo.htmland thezajo-{light,dark}.cssit pulls in, copied from Boost.LEAF — the meta description still advertised "Lightweight Error Augmentation Framework" — plusrouge-github.css. Antora supplies its own styling and does not read docinfo files.gentags.shanddoc/tagfiles. Theantora-cpp-tagfilesextension loads tagfiles named inext.cpp-tagfiles.files, whichantora.ymldoes not set, plus the cppreference tagfile it now bundles itself.gentags.shwrote to a file name that was not even present intagfiles.openmethod-theme.yml, an asciidoctor-pdf theme with no PDF build left, and the unreferencedskin.pngandopen.png.Also removed two orphan pages under
doc/modules/ROOT/pages. These were in the nav of no page, but Antora publishes pages regardless, so both did render:error_processing.adoc— empty file, empty article bodyvirtual_parameter.adoc— a stub titled "Macros" whose body showed unconverted Doxygen@refmarkup as literal textKept
library-detail.adoc, which is not in the Antora nav but is the Boost website's library page (Boost.JSON has one at the same path), anddoc/modules/ROOT/images.Verification
doc/build_antora.shwas run on this branch before and after the deletions and the two site trees compared withdiff -rq. Both builds exit 0 with the same six pre-existing warnings. The only differences are the two orphan pages:Every other output file is byte-identical. The sitemap loses exactly those two
<loc>entries; the search index goes from 374 to 372 titles. So the 29.adocfiles and the ten assets had no effect at all on the rendered site.🤖 Generated with Claude Code