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

From: Gennadiy Rozental (gennadiy.rozental_at_[hidden])
Date: 2007-06-25 16:48:39

"Douglas Gregor" <dgregor_at_[hidden]> wrote in message 
news:468025D2.4050102_at_osl.iu.edu...
> Gennadiy Rozental wrote:
>> "Matias Capeletto" <matias.capeletto_at_[hidden]> wrote in message
>> news:e9b043a10706250930l7842da82je74ba8b7ff9876bc_at_mail.gmail.com...
>> Boost should require BoostBook as a documentation format. This is the
>> format
>> documentation should be kept in source control and delivered with release
>> Boost shouldn't require what tools are used to generate BoostBook
>> documents.
>> Whether it's QuickBook, XML editor, any other facility is irrelevant and
>> libraries authors are free to use any of them (and keep some intermediate
>> files under source control if necessary)
>>
>>> This is one of the objectives of the "Improving Boost Docs" project.
>>>
>>
>> Hmm. I never got this fealing. At least I do not see .dokbook files in
>> libraries maintaining it's docs as quickbook.
>>
> 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. And how you make this 
file - you own business.

Gennadiy