Documentation and directory structure

I've just downloaded the 1.37 release. I have the svn tree, but I wanted the pre-built documentation. I was very disappointed that I found the documentation in different places depending on how it was generated. So for some libraries its in ../doc/html and for others its in libs/<library_name>/doc. This is really confusing. It also suggests that the documentation build is some humungous script which builds all the documentation at once. I realise that boost likes to do things like this way - but never the less its very inconvenient for those of us who just want to use a small portion of boost in any given project. Can't we rationalize the documentation build in to something like the following? a) directory structure .../libs/<library_name>/doc Jamfile.v2 (optional) html .... docbook ... quickbook ... whatever. b) ability to build documentation for one library at a time by invoking bjam or whatever Advantages a) consistent directory structure b) release could but would necessarily have to include the prebuilt documentation c) easier for developers to fiddle with documentation of one library at a time d) easier to extract one library from boost e) easier to understand and use the documentation build process Robert Ramey

on Tue Nov 04 2008, "Robert Ramey" <ramey-AT-rrsd.com> wrote:
I've just downloaded the 1.37 release. I have the svn tree, but I wanted the pre-built documentation.
I was very disappointed that I found the documentation in different places depending on how it was generated. So for some libraries its in ../doc/html and for others its in libs/<library_name>/doc.
This is really confusing.
Maybe, but at least it's covered in the Getting Started Guide, in the hopes new people will not go trolling around through the directory structure expecting to find the documentation they're after that way, and then be confused by it. -- Dave Abrahams BoostPro Computing http://www.boostpro.com
participants (2)
-
David Abrahams
-
Robert Ramey