Hi all,

My name is Leon from National University of Singapore and I would like to
participate in GSoC this year for Sphinx. I would like to develop support
for documenting languages other than python via doxygen.

Currently doxygen does a good job in parsing source code and extracting
relevant comments, but many features on sphinx are more superior (e.g.
javascript-based search, ReST format, better document flow, and even a
web-based dynamic interface if the other proposal gets accepted :)).
However, automatic extraction of module, function etc. documentations are
only supported in Python. By utilising the capability of doxygen to extract
inline documentation from other source formats, sphinx can be an ideal
documentation tool for a lot of projects.

To approach this project I would create a new sphinx extension and parse
doxygen-generated XML files to provide the necessary "autodoc"s like <
http://sphinx.pocoo.org/ext/autodoc.html>. There are some preliminary
parsing code done by WxWidgets community: <
http://groups.google.com/group/wxPython-dev/browse_thread/thread/83dd29510a4992de>
<
http://trac.wxwidgets.org/browser/wxWidgets/trunk/docs/doxygen/scripts/doxymlparser.py
>

I have a pretty good idea of how the project is supposed to be done, but I
am hesitant to apply as the main focus of this year's Python GSoC is to port
applications to Py3k. Do I still have a good chance to get in if I propose
this project?

Regards,

Leontius Adhika Pradhana

[P.S. I am aware of the idea from LLVM community, but using CLang would mean
that only C, C++, and ObjC were going to be supported. By contrast doxygen
supports far more languages.]

-- 
Leontius Adhika Pradhana (Leon)
http://leapon.net/

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to