• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Distributed under the Boost Software License, Version 1.0. (See
2# accomanying file LICENSE_1_0.txt or copy at
3# http://www.boost.org/LICENSE_1_0.txt
4
5import path ;
6import doxygen ;
7import quickbook ;
8
9# using auto-index ;
10using doxygen ;
11using quickbook ;
12using boostbook ;
13
14path-constant here : . ;
15
16rule run_doxygen ( files * : name )
17{
18    doxygen yap_reference
19      :
20        $(files)
21      :
22        <doxygen:param>EXTRACT_ALL=YES
23        # note that there is no detail::unspecified -- this is a hack to get all
24        # the SFINAE code out of the API docs.
25        <doxygen:param>"PREDEFINED=\"BOOST_YAP_DOXYGEN=1\" \\
26                                   \"lazy_enable_if=detail::unspecified\" \\
27                                   \"enable_if=detail::unspecified\""
28        <doxygen:param>HIDE_UNDOC_MEMBERS=NO
29        <doxygen:param>EXTRACT_PRIVATE=NO
30        <doxygen:param>ENABLE_PREPROCESSING=YES
31        <doxygen:param>MACRO_EXPANSION=YES
32        <doxygen:param>EXPAND_ONLY_PREDEF=YES
33        <doxygen:param>SEARCH_INCLUDES=NO
34        <doxygen:param>EXAMPLE_PATH=.
35        <reftitle>$(name)
36  ;
37
38}
39
40run_doxygen [ glob $(here)/../../../boost/yap/*.hpp ] : "Headers" ;
41
42install images_standalone : [ glob *.png ] : <location>html/yap/img ;
43explicit images_standalone ;
44
45install images_boostdoc : [ glob *.png ] : <location>../../../doc/html/yap/img ;
46explicit images_boostdoc ;
47
48xml yap
49    :
50        yap.qbk
51    :
52        <dependency>yap_reference
53    ;
54
55boostbook standalone
56    :
57        yap
58    :
59        # HTML options first:
60        # Use graphics not text for navigation:
61        <xsl:param>navig.graphics=1
62        # How far down we chunk nested sections, basically all of them:
63        <xsl:param>chunk.section.depth=10
64        # Don't put the first section on the same page as the TOC:
65        <xsl:param>chunk.first.sections=1
66        # How far down sections get TOC's
67        <xsl:param>toc.section.depth=10
68        # Max depth in each TOC:
69        <xsl:param>toc.max.depth=4
70        # How far down we go with TOC's
71        <xsl:param>generate.section.toc.level=10
72        # Set the path to the boost-root so we find our graphics:
73        <xsl:param>boost.root="../../../.."
74        # location of the main index file so our links work:
75        #<xsl:param>boost.libraries=../../../../../libs/libraries.htm
76
77        # PDF Options:
78        # TOC Generation: this is needed for FOP-0.9 and later:
79        # <xsl:param>fop1.extensions=1
80        <xsl:param>xep.extensions=1
81        # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
82        <xsl:param>fop.extensions=0
83        # No indent on body text:
84        <xsl:param>body.start.indent=0pt
85        # Margin size:
86        <xsl:param>page.margin.inner=0.5in
87        # Margin size:
88        <xsl:param>page.margin.outer=0.5in
89        # Yes, we want graphics for admonishments:
90        <xsl:param>admon.graphics=1
91        # Set this one for PDF generation *only*:
92        # default pnd graphics are awful in PDF form,
93        # better use SVG's instead:
94        # <xsl:param>admon.graphics.extension=".svg"
95
96        # <auto-index>on
97        # <auto-index-verbose>on
98        # <auto-index-internal>on
99        # <auto-index-script>yap.idx
100        # <quickbook-define>enable_index
101        # <auto-index-prefix>../../..
102        # <format>html:<auto-index-internal>on
103        # <format>docbook:<auto-index-internal>on
104        # <xsl:param>index.on.type=1
105
106        <dependency>images_standalone
107    ;
108
109alias boostdoc : yap : : : <dependency>images_boostdoc ;
110
111explicit boostdoc ;
112alias boostrelease ;
113explicit boostrelease ;
114