https://aznot.com/index.php?action=history&feed=atom&title=Python%2FDoxygen
Python/Doxygen - Revision history
2026-05-07T03:29:10Z
Revision history for this page on the wiki
MediaWiki 1.41.0
https://aznot.com/index.php?title=Python/Doxygen&diff=1686&oldid=prev
Kenneth: /* installation */
2015-02-05T17:42:08Z
<p><span dir="auto"><span class="autocomment">installation</span></span></p>
<p><b>New page</b></p><div>== Doxygen ==<br />
<br />
Doxygen - http://www.doxygen.org/<br />
* Doxygen - http://www.stack.nl/~dimitri/doxygen/<br />
<br />
"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." [http://en.wikipedia.org/wiki/Doxygen]<br />
<br />
Generate template configuration for you:<br />
doxygen -g <config-file><br />
<br />
Generate documentation:<br />
doxygen <config-file><br />
<br />
== doxypy ==<br />
<br />
See [[Python#doxypy]]<br />
<br />
== installation ==<br />
<br />
yum install doxygen<br />
pip install doxypy<br />
<br />
== Configuration ==<br />
<br />
Generate config:<br />
doxygen -g example.dox<br />
<br />
Suggested changes for Python:<br />
<pre><br />
PROJECT_NAME = Oeey<br />
OUTPUT_DIRECTORY = /www/oeey_docs<br />
FILE_PATTERNS = *.py README.txt<br />
RECURSIVE = YES<br />
EXCLUDE_PATTERNS = unit_tests argparse.py */tests/*<br />
SEARCHENGINE = YES<br />
ALPHABETICAL_INDEX = YES<br />
FILTER_SOURCE_FILES = YES<br />
INPUT_FILTER = doxypy<br />
SOURCE_BROWSER = YES<br />
</pre><br />
<br />
Usage:<br />
doxygen example.dox<br />
<br />
== Syntax ==<br />
<br />
README.txt index file:<br />
<pre><br />
/*! \mainpage My Project documentation.<br />
Some comment<br />
\htmlonly<br />
&lt;pre><br />
<br />
words words words<br />
words words words<br />
<br />
&lt;/pre><br />
\endhtmlonly<br />
*/<br />
</pre><br />
<br />
== keywords ==<br />
<br />
[[Category:Programming]]</div>
Kenneth