Re: [boost] [fusion] html docs woes

Subject: Re: [boost] [fusion] html docs woes
From: Joel de Guzman (joel_at_[hidden])
Date: 2011-07-18 00:02:15

On 7/18/2011 11:07 AM, Eric Niebler wrote:
> 
> On 7/17/2011 3:18 AM, Joel de Guzman wrote:
>> On 7/17/2011 5:50 PM, Daniel James wrote:
>>>> * No way for folks to read the HTML until it's actually released.
>>
>>> I upload the trunk documentation on the sourceforge sandbox site every
>>> time I build it, and there are redirects in subversion to take you
>>> there.
>>
>> That's a very good compromise. The only drawback is that
>> it requires an Internet connection, which is a PITA if you
>> have to go offline and don't have access to the docs. This
>> happens to me a lot of times and I hate it when it does.
> 
> If you know you are going offline, you can just build Fusion's docs from
> the source locally. Proto's docs are both integrated into the main doc
> build as well as build-able standalone. To do it, you just go to
> libs/proto/doc and type bjam. Blam-o! local HTML docs that you can read
> offline in a jiffy. (That's also how I test that Proto's docs build
> correctly and look good.)

Sure, but again, that requires you to be quickbook/docbook savvy.
I have no problem with it, but I do not want to require the users
to have to install the tool-chain just to be able to read the docs.
We all know how painful that is. So essentially, we are telling users:
if you want to read the docs, you must either be online, or be
quickbook-savvy and gen the docs yourself.

Regards,
-- 
Joel de Guzman
http://www.boostpro.com
http://boost-spirit.com