1# Convert documentation Jamfile 2 3# Copyright (c) Vladimir Batov 2009-2014 4# Distributed under the Boost Software License, Version 1.0. 5# See copy at http://www.boost.org/LICENSE_1_0.txt. 6 7using quickbook ; 8using doxygen ; 9 10path-constant here : . ; # convenient to refer to files in the same directory as this jamfile.v2 11path-constant boost-images : ../../../doc/src/images ; 12 13import modules ; 14 15if --enable-index in [ modules.peek : ARGV ] 16{ 17 ECHO "Building the convert docs with automatic index generation enabled." ; 18 using auto-index ; 19 project convert_doc : requirements 20 <auto-index>on 21 <auto-index-script>index.idx 22 <auto-index-prefix>. 23 <auto-index-verbose>on 24 <format>html:<auto-index-internal>on 25 <format>html:<xsl:param>generate.index=0 26 <format>pdf:<auto-index-internal>on 27 <format>pdf:<xsl:param>index.on.type=1 28 <quickbook-define>enable_index ; 29} 30else 31{ 32 project convert_doc ; 33 ECHO "Building the convert docs with automatic index generation disabled. Try building with --enable-index." ; 34} 35 36doxygen convert_reference 37 : 38 [ glob $(here)/../include/boost/convert.hpp $(here)/../include/boost/make_default.hpp $(here)/../include/boost/convert/*.hpp ] 39 : 40 <doxygen:param>PROJECT_NAME="CONVERT" 41 <doxygen:param>PROJECT_NUMBER=3 42 <doxygen:param>SORT_MEMBER_DOCS=NO 43 <doxygen:param>SHOW_INCLUDE_FILES=NO 44 <doxygen:param>MAX_INITIALIZER_LINES=0 45 <doxygen:param>VERBATIM_HEADERS=NO 46 <doxygen:param>WARNINGS=NO # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings for undocumented members. 47 # If EXTRACT_ALL is set to YES then this flag will automatically be disabled. 48 <doxygen:param>WARN_IF_UNDOCUMENTED=NO # If WARN_IF_UNDOCUMENTED is set to YES, 49 # then doxygen will generate warnings for undocumented members. 50 <doxygen:param>WARN_IF_DOC_ERROR=YES # If WARN_IF_DOC_ERROR is set to YES, Doxygen will generate warnings for 51 # potential errors in the documentation. 52 53 #<reftitle>"Reference" 54 <xsl:param>"boost.doxygen.reftitle=Boost.Convert C++ Reference" 55; 56 57xml convert 58 : 59 00_main.qbk 60 : 61 <dependency>convert_reference 62; 63 64boostbook standalone 65 : 66 convert 67 : 68 <xsl:param>boost.root=../../../.. 69 <xsl:param>chunk.section.depth=8 70 <xsl:param>toc.section.depth=8 # How far down sections get TOCs. 71 <xsl:param>toc.max.depth=4 # Max depth in each TOC. 72 73 # PDF Options: 74 # TOC Generation: this is needed for FOP-0.9 and later: 75 <xsl:param>fop1.extensions=0 76 <xsl:param>xep.extensions=1 77 # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9! 78 <xsl:param>fop.extensions=1 79 # No indent on body text: 80 <xsl:param>body.start.indent=0pt 81 # Margin size: 82 <xsl:param>page.margin.inner=0.5in 83 # Margin size: 84 <xsl:param>page.margin.outer=0.5in 85 # Paper type = A4 86 <xsl:param>paper.type=A4 87 # Yes, we want graphics for admonishments: 88 <xsl:param>admon.graphics=1 89 # Set this one for PDF generation *only*: 90 # default pnd graphics are awful in PDF form, 91 # better use SVG's instead: 92 <format>pdf:<xsl:param>admon.graphics.extension=".svg" 93 <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/ 94 ; 95 96install pdfinstall 97 : standalone 98 : <location>.. <install-type>PDF <name>convert.pdf 99 ; 100explicit css ; 101explicit images ; 102 103############################################################################### 104alias boostdoc ; 105explicit boostdoc ; 106alias boostrelease : standalone ; 107explicit boostrelease ; 108