|
Boost : |
Subject: Re: [boost] [iterator] Regenerating the iterator docs
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2015-08-25 04:42:07
> -----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.
<snip>
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.
Paul
--- Paul A. Bristow Prizet Farmhouse Kendal UK LA8 8AB +44 (0) 1539 561830
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk