Python/Doxygen

From Omnia
Jump to: navigation, search

Doxygen

Doxygen - http://www.doxygen.org/

"Doxygen is a documentation generator, a tool for writing software reference documentation. The documentation is written within code, and is thus relatively easy to keep up to date. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code." [1]

Generate template configuration for you:

doxygen -g <config-file>

Generate documentation:

doxygen <config-file>

doxypy

See Python#doxypy

installation

yum install doxygen
pip install doxypy

Configuration

Generate config:

doxygen -g example.dox

Suggested changes for Python:

PROJECT_NAME           = Oeey
OUTPUT_DIRECTORY       = /www/oeey_docs
FILE_PATTERNS          = *.py README.txt
RECURSIVE              = YES
EXCLUDE_PATTERNS       = unit_tests argparse.py */tests/*
SEARCHENGINE           = YES
ALPHABETICAL_INDEX     = YES
FILTER_SOURCE_FILES    = YES
INPUT_FILTER           = doxypy
SOURCE_BROWSER         = YES

Usage:

doxygen example.dox

Syntax

README.txt index file:

/*! \mainpage My Project documentation.
Some comment
\htmlonly
<pre>

words words words
words words words

</pre>
\endhtmlonly
*/

keywords