Skip to content

docs: enable site search via @antora/lunr-extension - #428

Merged
sgerbino merged 1 commit into
cppalliance:developfrom
sgerbino:docs-site-search
Sep 25, 2026
Merged

sgerbino merged 1 commit into
cppalliance:developfrom
sgerbino:docs-site-search

Conversation

@sgerbino

Copy link
Copy Markdown
Collaborator

Closes #401.

@antora/lunr-extension was already a dependency in doc/package.json but was never registered under antora.extensions in doc/local-playbook.yml, so the built site shipped no search. This registers it, first in the extension list with index_latest_only: true, matching the convention used by Boost.URL, dynamic_bitset, and openmethod.

Verified with a full local build_antora.sh run:

  • search-index.js (2.8 MB) is generated at the site root
  • _/js/vendor/lunr.js and _/js/search-ui.js are injected by the extension
  • Pages render the toolbar search box and load all three scripts

No UI-bundle changes are needed: the Boost UI's toolbar.hbs and footer-scripts.hbs are gated on SITE_SEARCH_PROVIDER, which the extension sets at build time.

@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://428.capy.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-09-25 19:39:49 UTC

@codecov

codecov Bot commented Sep 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.09%. Comparing base (ca59f94) to head (a29aa63).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #428   +/-   ##
========================================
  Coverage    98.09%   98.09%           
========================================
  Files          130      130           
  Lines         6289     6289           
========================================
  Hits          6169     6169           
  Misses         120      120           
Flag Coverage Δ
linux 98.08% <ø> (ø)

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


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ca59f94...a29aa63. Read the comment docs.

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

@cppalliance-bot

Copy link
Copy Markdown

GCOVR code coverage report https://428.capy.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://428.capy.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff Report https://428.capy.prtest3.cppalliance.org/diff-report/index.html

Build time: 2026-09-25 19:52:49 UTC

@sgerbino
sgerbino merged commit 2c575f3 into cppalliance:develop Sep 25, 2026
39 checks passed
@sgerbino
sgerbino deleted the docs-site-search branch September 25, 2026 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs: enable site search

2 participants