Skip to content

simplified doc/Jamfile.v2 #336

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.

Sign up for GitHub

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

Merged
joaquintides merged 1 commit into from
Jan 3, 2026
Merged

simplified doc/Jamfile.v2 #336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 10 additions & 44 deletions doc/Jamfile.v2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,23 @@
import generate ;
import path ;
import property-set ;
import virtual-target ;
# Copyright 2026 Joaquin M Lopez Munoz
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

path-constant HERE : . ;
make html_ : build_antora.sh : @run-script ;

make html/index.html : build_antora.sh : @run-script ;
generate files-to-install : html/index.html : <generating-rule>@delayed-glob ;
install install
: files-to-install
: <location>html
<install-source-root>html/unordered
;
explicit html/index.html files-to-install ;

# this runs the antora script
actions run-script
{
bash $(>)
}

# this globs after its sources are created
rule delayed-glob ( project name : property-set : sources * )
{
for local src in $(sources)
{
# the next line causes the source to be generated immediately
# and not later (which it normally would)
UPDATE_NOW [ $(src).actualize ] ;
}

# we need to construct the path to the globbed directory;
# this path would be <current-project>/antora
local root = [ path.root html [ $(project).location ] ] ;
local files ;
make cleanup_node_modules_ : html_ : @cleanup-node-modules ;

# actual globbing happens here
for local file in [ path.glob-tree $(root) : * ]
{
# we have to skip directories, because our match expression accepts anything
if [ CHECK_IF_FILE $(file) ]
{
# we construct a list of targets to copy
files += [ virtual-target.from-file $(file:D=) : $(file:D) : $(project) ] ;
}
}

# we prepend empty usage requirements to the result
return [ property-set.empty ] $(files) ;
actions cleanup-node-modules
{
bash -c "rm -rf node_modules"
Copy link
Member

@grisumbras grisumbras Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bash -c shouldn't be necessary here. It is needed in run-script because otherwise building from the doc directory would invoke build_antora.sh (and not the relative path to that script), which will fail.

rm is a shell command, so it doesn't need another shell wrapper. On the other hand, node_modules is incorrect, as it only works if b2 is invoked from the doc directory. Replace with this:

import path ;
path-constant DOC_DIR : . ;
.node_modules = [ path.join $(DOC_DIR) node_modules ] ;

actions cleanup-node-modules
{
    rm -rf $(.node_modules)
}

}

###############################################################################
alias boostdoc ;
explicit boostdoc ;
alias boostrelease : install ;
explicit boostrelease ;
alias boostrelease : html_ ;
explicit boostrelease ;
Loading