Subject: Re: [boost] [iterator] Regenerating the iterator docs
From: Edward Diener (eldiener_at_[hidden])
Date: 2015-08-25 07:01:58
On 8/25/2015 4:42 AM, Paul A. Bristow wrote:
>> -----Original Message-----
>> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Edward Diener
>> Sent: 24 August 2015 19:53
>> To: boost_at_[hidden]
>> Subject: Re: [boost] [iterator] Regenerating the iterator docs
>>> On 08/24/2015 12:06 PM, Edward Diener wrote:
>>>> I have updated a very small portion of the iterator docs and now I
>>>> need to regenerate the documentation. Evidently despite iterator
>>>> having quickbook documentation the actual documentation presented to
>>>> end-users is created from RST files, python scripts, and make files.
>>>> But I do not see the process of regenerating the docs explained
>>>> anywhere so I am wondering if anyone knows how to do it.
> As the Irishman said when asked the way "I wouldn't start from here!"
> The long-term answer is to convert the information in RST format to Doxygen-syntax comments in the
> actual code.
> Then everything will be generated automatically using the Quickbook toolchain, including an index.
We do have quickbook files for the documentation, which appears a
duplicate of the RST docs in content. The jamfile for building the
quickbook docs is a little sparse ( no pdf and no index ) but I can
update that. The difference is that the build from RST files, which is
what the end-user currently sees in the Boost distros, has a slightly
more elaborate look-and-feel than what the quickbook docs generate. I am
not up to duplicating that more elaborate look-and-feel but maybe others
would like to do it if they feel it is needed.
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk