We use Doxygen to generate the API documentation automatically.
-
Install Doxygen following link if you have not already done so.
-
Run doxygen command with
MintPy/docs/Doxyfile
to generate the API documentation in html and latex format (to$MINTPY_HOME/docs/api_docs
by default).
cd $MINTPY_HOME/docs/api
/Applications/Doxygen.app/Contents/Resources/doxygen Doxyfile
open ../api_docs/html/index.html
- To generate hyperlinked PDF version of the API documentation from latex:
cd $MINTPY_HOME/docs/api_docs/latex
make