Re: Sphinx integration

Rene Rivera <[email protected]>
Newsgroups gmane.comp.lib.boost.documentation
Organization Redshift Software, Inc.
Message-ID <[email protected]>
On 10/11/2011 8:57 AM, Mateusz Loskot 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?

<http://svn.boost.org/svn/boost/trunk/tools/build/v2/tools/doxproc.py>

And there's support for using that already in the b2 "doxygen.jam" file 
<http://svn.boost.org/svn/boost/trunk/tools/build/v2/tools/doxygen.jam>:

# Which processor to use for various translations from Doxygen.
feature.feature doxygen.processor : xsltproc doxproc : propagated implicit ;

And of course the currently used xsltproc translator. Is this what you 
are wanting? Or did I not understand the thread?


-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.