Re: Sphinx integration
Mateusz Loskot <[email protected]>
| Newsgroups | gmane.comp.lib.boost.documentation |
|---|---|
| Message-ID | <[email protected]> |
On 11/10/11 15:55, Dave Abrahams wrote: > on Tue Oct 11 2011, Mateusz Loskot<mateusz-AT-loskot.net> wrote: >> On 11/10/11 14:40, Dave Abrahams wrote: >>> on Tue Oct 11 2011, Mateusz Loskot<mateusz-AT-loskot.net> wrote: >>> >>>>> Sorry, I don't know what you mean by "implement the unification for use >>>>> and processing of Doxygen in Boost." Could you explain? >>>> >>>> I mean that, presumably, it is a good idea if all Boost libraries >>>> documented using Doxygen use exactly the same tool to transform the >>>> Doxygen comments into API reference in BoostBook or QuickBook format. >>>> >>>> This way, look& feel of all API references would be consistent >>>> and authors would probably be encouraged to update comments for better >>>> Boost API documentation coverage. >>> >>> +1 >>> >>> In fact, it shouldn't be up to the individual libraries; the >>> transformation should be part of the documentation build process. >> >> Yes, that's what I have in mind. >> >> Now, regarding the implementation of such translator: >> - is there anything already available in current doc tools in Boost, >> Vault,...? >> - if not, where it should go? separate cmd line tool like quickbook? >> - what's best way to parse XML for BoostDoc for ? libxml, Boost.Tree, >> Spirit? > > I don't think I know the answers oto these questions. There's > *something* in Boost.Build for this, but that's as much as I remember. OK. I'll try to discover it myself. Thank you, Paul and others for brainstorming the whole thing. Best regards, -- Mateusz Loskot, http://mateusz.loskot.net Charter Member of OSGeo, http://osgeo.org Member of ACCU, http://accu.org