Skip to content

Commit 53ef947

Browse files
committed
Doc install and redirection
1 parent ecfe51c commit 53ef947

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed

doc/Jamfile

+20-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import sequence ;
66

77
# All paths must be absolute to work well with the Doxygen rules.
88
path-constant this_dir : . ;
9+
path-constant target_dir : html ;
910
path-constant redis_root_dir : .. ;
1011
path-constant include_dir : ../include ;
1112
path-constant examples_dir : ../examples ;
@@ -20,7 +21,8 @@ local examples = [ path.glob-tree $(examples_dir) : *.hpp *.cpp ] ;
2021
# which is not correct.
2122
local stylesheet_arg = [ sequence.join "\"$(stylesheet_files)\"" : " " ] ;
2223

23-
doxygen autodoc.html
24+
# The doxygen rule requires the target name to end in .html to generate HTML files
25+
doxygen doc.html
2426
:
2527
$(includes) $(examples) $(readme)
2628
:
@@ -59,11 +61,27 @@ doxygen autodoc.html
5961
<doxygen:param>DIRECTORY_GRAPH=NO
6062
;
6163

64+
explicit doc.html ;
65+
66+
# The doxygen rule only informs b2 about the main HTML file, and not about
67+
# all the doc directory that gets generated. Using the install rule copies
68+
# only a single file, which is incorrect. This is a workaround to copy
69+
# the generated docs to the doc/html directory, where they should be.
70+
make copyhtml.tag : doc.html : @copy_html_dir ;
71+
explicit copyhtml.tag ;
72+
actions copy_html_dir
73+
{
74+
rm -rf $(target_dir)
75+
mkdir -p $(target_dir)
76+
cp -r $(<:D)/html/doc/* $(target_dir)/
77+
echo "Stamped" > "$(<)"
78+
}
79+
6280
# These are used to inform the build system of the
6381
# means to build the integrated and stand-alone docs.
6482

6583
alias boostdoc ;
6684
explicit boostdoc ;
6785

68-
alias boostrelease : autodoc.html ;
86+
alias boostrelease : copyhtml.tag ;
6987
explicit boostrelease ;

index.html

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<html>
2+
3+
<head>
4+
<title>Boost.Redis</title>
5+
<meta http-equiv="refresh" content="0; URL=./doc/html/index.html">
6+
</head>
7+
8+
<body>
9+
Automatic redirection failed, please go to
10+
<a href="./doc/html/index.html">./doc/html/index.html</a>
11+
<hr>
12+
<tt>
13+
Boost.Redis<br>
14+
<br>
15+
Copyright&nbsp;(C)&nbsp;2023&nbsp;Marcelo&nbsp;Zimbres<br>
16+
<br>
17+
Distributed under the Boost Software License, Version 1.0.
18+
(See accompanying file LICENSE_1_0.txt or copy at
19+
<a href=http://www.boost.org/LICENSE_1_0.txt>http://www.boost.org/LICENSE_1_0.txt</a>) <br>
20+
<br>
21+
</tt>
22+
</body>
23+
24+
</html>

0 commit comments

Comments
 (0)