Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: cpp-tagfiles is antora extension #851

Merged
merged 3 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions doc/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,19 @@ ext:
command: node doc/generate-files.mjs
scan:
dir: doc/build/generated-files
cpp-tagfiles:
files:
- file: ./doc/tagfiles/boost-url-doxygen.tag.xml
base_url: 'xref:reference:'
- file: ./doc/tagfiles/boost-system-doxygen.tag.xml
base_url: https://www.boost.org/doc/libs/master/libs/system/doc/html/
- file: ./doc/tagfiles/boost-core-doxygen.tag.xml
base_url: https://www.boost.org/doc/libs/master/libs/core/doc/html/
- file: ./doc/tagfiles/boost-filesystem-doxygen.tag.xml
base_url: https://www.boost.org/doc/libs/master/libs/filesystem/doc/
using-namespaces:
- boost::urls
- boost::urls::grammar
- boost::system
- boost::core

629 changes: 629 additions & 0 deletions doc/lib/cpp-tagfiles.js

Large diffs are not rendered by default.

328 changes: 0 additions & 328 deletions doc/lib/cpp.js

This file was deleted.

12 changes: 10 additions & 2 deletions doc/local-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,24 @@ content:

ui:
bundle:
url: https://github.com/cppalliance/site-docs/releases/download/ui-master/ui-bundle.zip
url: https://github.com/boostorg/website-v2-docs/releases/download/ui-master/ui-bundle.zip
snapshot: true

antora:
extensions:
- require: '@antora/lunr-extension' # https://gitlab.com/antora/antora-lunr-extension
index_latest_only: true
- '@antora/collector-extension'
- require: ./lib/cpp-tagfiles.js
cpp-tagfiles:
using-namespaces:
- 'boost::'
asciidoc:
attributes:
# Enable pagination
page-pagination: ''
# Remove the sidenav and include TOC in index.adoc page
remove-sidenav: ''
extensions:
- ./lib/boost-link-inline-macro.js
- ./lib/cpp.js
- '@asciidoctor/tabs'
Loading
Loading