On 4/13/07, Dieter <[EMAIL PROTECTED]> wrote: > On 4/13/07, Ivan Vilata i Balaguer <[EMAIL PROTECTED]> wrote: > > Dieter (el 2007-04-13 a les 02:45:22 -0400) va dir:: > > > > > Just curious what, if any, editing tools are you using for the docs? > > > I see the format is docbook in a dtd 4.4 format. > > > > We use good old Emacs to edit the manual. Francesc uses the PSGML > > package and I use the nxml package (both of them seem to work pretty > > well). For text documents and docstrings we use reStructuredText, which > > we try to keep in sync as faithfully as we can with Docbook for the > > reference chapter, still by hand (suggestions for automatic conversion, > > anyone?). > > > > The worst point of this is having to keep docstrings and the manual in > > sync, as you can imagine. To avoid glitches, we edit docstrings and the > > manual simultaneously, so changes to docstrings and the manual go in the > > same commit. > > > > Hope that helps, > > > > :: > > > > Ivan Vilata i Balaguer >qo< http://www.carabos.com/ > > Cárabos Coop. V. V V Enjoy Data > > "" > > > > -----BEGIN PGP SIGNATURE----- > > Version: GnuPG v1.4.3 (GNU/Linux) > > > > iQCVAwUBRh85hp+xtF0dvCVFAQKADQP+J4Pvu7tNRrlvtunOUc/OhW8++57wF7/0 > > 7UGJG8ydGb1gD9xxjqRKxy7WyRT+tg8OWcTsIBE0OzmtsXU46BfHFubTCOIUojPZ > > jRQz1uVazReQlJ361JXE34xoKYypRn9m+OKfMlvAMFQ6b8erTdqCCwdcxgFtQjAv > > TO9SUrBh0mI= > > =x4O5 > > -----END PGP SIGNATURE----- > > > > > > I was afraid you were gonna say that... lol > > 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 ------------------------------------------------------------------------- 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
