Hello hello,
This post is half related to Python because it is about its automatic documentation generation.
I have been playing with Doxygen for a while in C, it was adapted to Python in a second evolution stage a while ago. However after reading a lot of small examples, and getting a pretty complete image of my project in HTML (with introduction page, module list , etc.) I find myself in front of this question:
How to comment the import statements so that they get in the documentation?
For those who are curious about Doxygen and who think they may need this (it allows to you to avoid writing a document describing your project in detail by getting the comments and some special comments for better formatting, from your source files directly), here is where to find python related stuff:
Official site:
http://www.stack.nl/~dimitri/doxygen/
Official site pointers for Python(although normally you can use @ tags and not necessarily the triple quote for comments):
http://www.doxygen.nl/docblocks.html
For Doxywizard file settings(you can also play around and see which does what):
http://engtech.wordpress.com/2007/03/20/automatic_documentation_python_doxygen/
So, if any of you who have used this before come accross the import statement comment I'm buying :). I'll let you know what I find ...
Thanks in advance,
T