I think this is the appropriate place to post this question; if
not, would someone kindly redirect me.
I am working on a project to create Perl-specific documentation
for the Perl interface to the wxwidgets library. I admire the
extensive, attractive, and usable documentation you have for the wx
module at wxpython.org. I am hoping that we in the Perl world can
leverage some of your experience.
The footer on your pages shows that the HTML was generated by
Epydoc. Obviously that's python-specific, and there are docgen
systems that work for Perl, but what I'm more interested in is how the
C++-to-python documentation conversion happens. Do you have a tool
that works from the wxwidgets source, or its docs, or do you have a
whole parallel set of comments and/or docs that mirror the C++ version
and which must be maintained each version?
Any insight you could give me would help us on our project. Thank
you very much.
The current wxPython docs are done with a separate set of Python-specific docstrings attached to the API elements, and epydoc is just one of the tools that is able to extract and format Python docstrings. However this has proved to be too much effort to implement and maintain and so it has been stuck in a partially finished state for a long time.
There is a new project underway that will shift most of the wrapper code generation to using the XML produced from Doxygen being run on the wxWidgets interface definition files (doc specific versions of the C++ headers.) The plan is to also extract the documentation from the XML nodes, massage it if necessary, and produce the Python docs from there.
I think this is the appropriate place to post this question; if
not, would someone kindly redirect me.
I am working on a project to create Perl-specific documentation
for the Perl interface to the wxwidgets library. I admire the
extensive, attractive, and usable documentation you have for the wx
module at wxpython.org. I am hoping that we in the Perl world can
leverage some of your experience.
The footer on your pages shows that the HTML was generated by
Epydoc. Obviously that's python-specific, and there are docgen
systems that work for Perl, but what I'm more interested in is how the
C++-to-python documentation conversion happens. Do you have a tool
that works from the wxwidgets source, or its docs, or do you have a
whole parallel set of comments and/or docs that mirror the C++ version
and which must be maintained each version?