doxypy is an input filter for Doxygen. It reformats python comments to conform to doxygen documentation blocks. This makes it possible to use the Doxygen/Javadoc syntax inside of docstrings when writing code documentation and automatically generate API documentation out of it instead of being forced to use non-python documentation blocks or to document code redundantly.
doxypy is licensed under the GPLv2.
Should you discover any bugs, please report them.
doxypy was written by
In order to make Doxygen preprocess files through doxypy simply install it by running
sudo ./setup.py install
and then add the following lines to your Doxyfile
FILTER_SOURCE_FILES = YES INPUT_FILTER = "python /usr/local/bin/doxypy.py"
That's it. Doxygen will now preprocess every source file through doxypy and then process doxypy's output.
If you want to make Doxygen recognize your module docstrings, you have to add a namespace command to the docstring (see the Doxygen documentation).
Should you be unfamiliar with doxygen and using it to document python code you might want to take a look at this tutorial by Greg Smith.
--debug option for generating debug output on stderr--autobrief option