• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright (c) 2016-2019 Klemens D. Morgenstern, Hans Dembinski
2#
3# Distributed under the Boost Software License, Version 1.0. (See accompanying
4# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
5
6# How to set up Boost Build for building the documentation:
7# https://www.boost.org/doc/libs/1_72_0/doc/html/quickbook/install.html
8
9project doc/histogram ;
10
11import os ;
12import doxygen ;
13import quickbook ;
14import boostbook : boostbook ;
15import notfile ;
16
17path-constant THIS_PATH : . ;
18
19doxygen reference
20:
21  $(THIS_PATH)/../../../boost/histogram.hpp
22  [ glob $(THIS_PATH)/../../../boost/histogram/*.hpp ]
23  [ glob $(THIS_PATH)/../../../boost/histogram/accumulators/*.hpp ]
24  [ glob $(THIS_PATH)/../../../boost/histogram/algorithm/*.hpp ]
25  [ glob $(THIS_PATH)/../../../boost/histogram/axis/*.hpp ]
26:
27  <doxygen:param>QUIET=YES
28  <doxygen:param>WARNINGS=YES
29  <doxygen:param>WARN_IF_DOC_ERROR=YES
30  <doxygen:param>EXTRACT_ALL=NO
31  <doxygen:param>EXTRACT_PRIVATE=NO
32  <doxygen:param>HIDE_UNDOC_MEMBERS=YES
33  <doxygen:param>HIDE_UNDOC_CLASSES=YES
34  <doxygen:param>EXPAND_ONLY_PREDEF=YES
35  <doxygen:param>JAVADOC_AUTOBRIEF=YES
36  <doxygen:param>EXCLUDE_SYMBOLS=detail
37  <doxygen:param>"PREDEFINED=\"BOOST_HISTOGRAM_DOXYGEN_INVOKED\" \\
38                             \"BOOST_ATTRIBUTE_NODISCARD\""
39;
40
41actions doxygen-postprocessing
42{
43  python3 $(THIS_PATH)/doxygen_postprocessing.py "$(>)"
44}
45
46notfile reference-pp : @doxygen-postprocessing : reference.xml ;
47
48path-constant images_location : html ;
49
50boostbook histogram
51:
52  histogram.qbk
53:
54  <xsl:param>boost.root=../../../..
55  <xsl:param>boost.libraries=../../../libraries.htm
56  <xsl:param>boost.mathjax=1
57  <xsl:param>chunk.first.sections=1
58  <xsl:param>generate.toc="chapter nop section toc"
59  <xsl:param>toc.section.depth=3
60  <dependency>reference-pp
61  <format>pdf:<xsl:param>img.src.path=$(images_location)/
62  <format>pdf:<xsl:param>boost.url.prefix="http://www.boost.org/doc/libs/release/doc/html"
63;
64
65alias boostdoc ;
66explicit boostdoc ;
67alias boostrelease : histogram ;
68explicit boostrelease ;
69