Re: [cpp-netlib-devel] [netlib] Preparing for 0.9 and 0.8.1 Release, Help Wanted; Readying for Boost Submission

[Dean M. B. <mik...@gm...>]

On Sun, Jan 2, 2011 at 2:37 AM, Raindog <ra...@ma...> wrote:
> On 1/1/2011 9:00 AM, Dean Michael Berris wrote:
>>
>> * Documentation -- please, if you have example use cases that you want
>> to contribute, now is the time to contribute them. If you have real
>> world use cases where you're actually using cpp-netlib, now would be a
>> good time to have your use case highlighted in the documentation.
>
> Why not use the boost documentation toolchain to generate documentation
> with the look and feel of the current boost docs?
>

There's a reasoning for that, and it mostly has to do with better tool support.

If you've actually tried dealing with the documentation tool chain for
Boost (quickbook, docbook, etc.) then you'll see what I mean. There
are also other Boost libraries that rely on RST instead of quickbook
that produce similar if not better documentation output that
quickbook+etc. produce.

Also, the documentation used to be in Quickbook and it got harder and
harder to maintain. Eventually Glyn (who was mostly writing the
documentation) and I (mostly wanting to contribute to the
documentation effort more) decided that continuing with
Quickbook+BoostBook wasn't a good use of our time, and switched to a
much easier input format in RST, and Glyn played around with Sphinx to
generate the documentation in a sartisfactory manner.

If you want to move back to Quickbook, that effort would be welcome --
and if someone wants to take on the documentation effort from Glyn and
I please let us know what to expect as well. We'll look forward to
your contributions as pull requests. ;)

Have a good one and I hope this answers the question satisfactorily.

-- 
Dean Michael Berris
about.me/deanberris