Dieter (el 2007-04-13 a les 08:25:34 -0400) va dir:: > On 4/13/07, Dieter <[EMAIL PROTECTED]> wrote: > > On 4/13/07, Dieter <[EMAIL PROTECTED]> wrote: > […] > > > How about considering an all in one framework like Doxygen. I really > > > liked using for my c and c++ code. I see it now accommodates python. > > > See the following: > > > > > > Home: > > > http://www.stack.nl/~dimitri/doxygen/ > > > Python Specific Article: > > > http://engtech.wordpress.com/2007/03/20/automatic_documentation_python_doxygen/ > > > External Extension: > > > http://code.foosel.net/doxypy > > > > > > > Another showing the markup syntax: > > http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks > > > > Epydoc was recently improved and seems to allow a nice amount of > flexibility in combination with the restructured text. Not to mention, > it supports all the features found in normal doxygen (except for the > built in search engine). > > I'm gonna go ahead and transfer the docs over. Any comments?
What do you mean with that sentence? (Sorry, my English is not so
good.) If you mean you're going to convert the docs to some of those
formats, allow me to *strongly* disagree. In the first place, I'm not
eager to start such an effort without adequately discussing the pros and
cons of each proposal. Second, we're in the process of overhauling and
synchronising docs for the 2.0 release, so it's not the best moment to
do it. ;) And third, none of the proposals seem to be adequate for the
PyTables docs, since we need a tool which supports both narrative and
reference sections with cross-references between them (leaves Epydoc
out, dont't know about Doxygen), with good browseable and printed
output, and which supports introspection of docstrings (lots of classes
in PyTables are dynamically generated, which leaves Doxygen out).
You see, if it was as easy as that we wouldn't be keeping the docs in
sync by hand! ;)
Of course, you can do what you want with your own branch, but I still
advise you to wait until the docs are settled for an easier work.
::
Ivan Vilata i Balaguer >qo< http://www.carabos.com/
Cárabos Coop. V. V V Enjoy Data
""
signature.asc
Description: Digital signature
------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys-and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________ Pytables-users mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/pytables-users
