How to generate the documentation ? |
Each mmx package pkgname
contains some documentation files, which can be found in the folder
pkgname/doc. The documentation written in TeXmacs is found in pkgname/doc/texmacs.
The documentation of the C++ files is found in
the files themselves. It is processed with doxygen.
In order to generate the documentation, the option DOC
should be turned ON while configuring the package with
cmake. Then the make command produces
the documentation in the folder ${CMAKE_BINARY_DIR}/html/pkgname.
For that texmacs and doxygen should be installed.
Here are instructions to generate only the (html) documentation for
all the packages:
cmake ../mmx -DDOC=ON -DLIBS=OFF -DALL=ON
make |
© 2008 Bernard Mourrain
Permission is granted to copy, distribute and/or modify this document
under the terms of the
GNU General Public License. If you
don't have this file, write to the Free Software Foundation, Inc., 59
Temple Place - Suite 330, Boston, MA 02111-1307, USA.