Boost logo

Boost :

Subject: Re: [boost] ATTENTION: Library requirements..
From: Louis Dionne (ldionne.2_at_[hidden])
Date: 2016-01-09 21:45:27


Rene Rivera <grafikrobot <at> gmail.com> writes:

>
> [...]
>
> 1. A library is required to have HTML documentation.
> 2. A library *can* integrate into the global Boost documentation.
> 3. If a library doesn't do #2 it *must* provide prebuilt HTML documentation.
>
> Hence, even though Predef uses quickbook, it's never done #2. Therefore
> Predef does #3

Can't a library provide a Jamfile that generates the documentation, even if
that documentation does not integrate with the global Boost documentation?
It would be straightforward to require that doing `cd doc && b2` generates
the documentation into `doc/html`, with index.html as an entry point.

Committing pre-generated documentation is a big no-no, at least for me.

Regards,
Louis


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