Subject: Re: [boost] [1.56] Sorry but no PDF doc build (build script has been broken)
From: Niall Douglas (s_sourceforge_at_[hidden])
Date: 2014-08-11 07:59:16
On 11 Aug 2014 at 12:24, John Maddock wrote:
> >> Sorry folks, but as things stand there will be no PDF build of the docs
> >> for 1.56 as the build script appears to be hopelessly broken :-(
> >> Each time I fix one Boost.Build error it just leads to another, and
> >> frankly at present I have neither time nor inclination to keep tracking
> >> these down. If anyone wants to experience some pain then trying to
> >> invoke bjam in /doc/pdf/ will give you an idea of some of the issues.
> Which so freaking inscrutable that I'm pretty sure it's a Japanese
> translation of Klingon.
> I suspect the only proper solution is to have each library's Jamfile
> include an install rule to build the PDF and put it under dist/pdf. But
> with >60 libraries to patch and apparently the only way to submit a pull
> request for each (fork, clone, patch, test and submit), then do the same
> for master *and* develop branches, wait and hope that the maintainer is
> active and feeling favourable.... well you see my problem!
> Apologies for the rant, John.
No, you're spot on. I suspect the modularisation script didn't
modularise PDF docs. I found a ton of path breakage.
I did however eventually get PDF docs working for proposed Boost.AFIO
and which you can witness at
cc-4.6/debug/afio.pdf. Getting docs working correctly was the hardest
part of the modularisation effort :(
Anyway, here is the PDF docs build script used by the CI, this might
be helpful to you:
../b2 -a ../libs/afio/doc pdf
This produces an output into:
It won't generate without error into boost-local/docs/pdf for some
My user-config.jam contains nothing special. I did install all the
docbook tools into PATH though.
Finally, my doc/Jamfile.v2 for AFIO, this took quite a lot of trial
and error before it worked right:
# This documentation machinery is derived from Boost.Geometry
# Use, modification and distribution is subject to the Boost Software
# Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
project afio/doc ;
# Auto-index, experimental. Commented otherwise does not build
#using auto-index ;
using quickbook ;
path-constant here : . ;
# TOC generation: this is needed for FOP 0.2, but must not be
set to zero for FOP-0.9!
# No indent on body text:
# Margin size:
# Margin size:
install pdfinstall : afio/<format>pdf : <location>. <name>afio.pdf
explicit pdfinstall ;
Hopefully some of the above will be useful to you.
-- ned Productions Limited Consulting http://www.nedproductions.biz/ http://ie.linkedin.com/in/nialldouglas/
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk