How to document Python code using Doxygen

Hanno Fietz picture Hanno Fietz · Sep 12, 2008 · Viewed 120.1k times · Source

I like Doxygen to create documentation of C or PHP code. I have an upcoming Python project and I think I remember that Python doesn't have /* .. */ comments, and also has its own self-documentation facility which seems to be the pythonic way to document.

Since I'm familiar with Doxygen, how can I use it to produce my Python documentation? Is there anything in particular that I need to be aware of?

Answer

Kevin Mack picture Kevin Mack · Jan 30, 2009

The doxypy input filter allows you to use pretty much all of Doxygen's formatting tags in a standard Python docstring format. I use it to document a large mixed C++ and Python game application framework, and it's working well.