Documentation

Table of Contents Doxygen Python support Call graphs Sphinx Misc

Doxygen

Python support

• "two methods" of marking documentation for processing using Doxygen
  • more details here
• example of Python Doxygen config file with explanation

Call graphs

• gprof2dot.py takes output from various profiling tools and generates call graphs
  • supports both C++ (gprof) and Python (cProfile)
  • requires "graphviz/dot"

Sphinx

• Sphinx intro tutorial 1
• Minimal setup for autodocumentation

Misc

• git hooks