Re: [boost] documentation (ToC) question

Subject: Re: [boost] documentation (ToC) question
From: Daniel James (dnljms_at_[hidden])
Date: 2014-06-10 09:52:34

On 10 June 2014 13:11, Andrey Semashev <andrey.semashev_at_[hidden]> wrote:
>
> 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.

If you're achieving your result by creating separate documents, you
can possibly get the same effect in a single document by structuring
it as a 'book' or 'part' or something similar. This requires writing
boostbook or using a quickbook 1.6 document. If it has the 'book'
type, it can include 'library' and 'chapter' documentation in it, and
docbook will format them in a pretty similar manner to if they're
standalone. You can see this in the quickbook documentation.
Especially on the feature/doc-tools-documentation where
'doc-guide.qbk' is a book that includes two parts. You can see it at:

http://boostorg.github.io/quickbook/doc/html/index.html

An alternative is to use escaped boostbook to get a similar effect, as
they do in the math documentation.

Unfortunately, it's tricky for libraries in the combined
documentation, as document type 'library' converts to 'chapter' in
docbook, and it's invalid to include anything but sections in a
chapter. You might be able to get away with it, but there's always the
possibility of problems with invalid markup.

There's a little bit of documentation here:

http://www.boost.org/doc/libs/1_55_0/doc/html/quickbook/syntax/structure.html