Re: [boost] Boost documentation format (was Re: Boost documentation)

From: Gennadiy Rozental (gennadiy.rozental_at_[hidden])
Date: 2007-06-25 17:15:33

"Peter Dimov" <pdimov_at_[hidden]> wrote in message 
news:01fa01c7b76c$4287de60$6407a80a_at_pdimov2...
> Gennadiy Rozental wrote:
>> "Douglas Gregor" <dgregor_at_[hidden]> wrote in message
>> news:468025D2.4050102_at_osl.iu.edu...
>
>>> The DocBook or BoostBook XML will be generated via Quickbook when
>>> needed. Or do you want the DocBook/BoostBook XML to always be in the
>>> source tree, even if it can be regenerated?
>>
>> Yes. Essentially  I should be able to generate docs for any library
>> and know nothing about quickbook and it's tools whatsoever.
>
> I think that a well-placed 'bjam' command can do that since QuickBook can
> bootstrap itself (if it supports an HTML target directly).

I personally would prefer to keep Boost.Build away from docs generation. IOW 
I shouldn't be required to know/have bjam to do it.

> In contrast, it is not possible to generate docs knowing nothing about 
> DocBook and its
> tools. But I may be misunderstanding something.

1. It will be true for cvs users only
2. If we decide Boost.Book to be documentation format it should be expected
3. It can be avoided with assigned publicly available stylesheets. For 
example library A developer may put stylesheet as <lib>/doc/html.xsl and 
assign it as default in XML file. That any user may just open this file 
using browser and see HTML.

Gennadiy