Boost logo

Boost :

Subject: Re: [boost] documentation (ToC) question
From: Andrey Semashev (andrey.semashev_at_[hidden])
Date: 2014-06-10 08:11:04


On Tuesday 10 June 2014 15:03:13 Peter Dimov wrote:
> John Maddock wrote:
> > I believe toc.max.depth is the param you want, for example like this:
> > http://www.boost.org/doc/libs/1_55_0/libs/math/doc/html/dist.html
>
> No, that's not quite what I wanted. toc.max.depth controls the depth of the
> master ToC, and that's quite fine; what I wanted was to control the depth of
> the section ToC. For example, here
>
> http://beta.boost.org/doc/libs/1_55_0/doc/html/atomic/thread_coordination.ht
> ml
>
> there's a section ToC right after "Thread coordination using Boost.Atomic",
> and I wanted nested sections to appear inside, indented, as they do in the
> master ToC.

I think you can achieve that if you make each sub-library docs as a separate
document, not a part included into the whole Boost.Core document. You'll have
to compile each sub-library docs separately in the Jamfile. This way it was
done in Boost.Utility before we moved the components from there.

Naturally, you'll need to generate the root Boost.Core page from a separate
QuickBook document, and insert links to the sub-library docs in it. I suspect,
this won't work well with PDF.


Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk