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