Pregenerated versions of the documentation are available here
| English: | HTML | EPUB | |
| Spanish: | HTML | EPUB |
Alternatively, you can generate the user's manual in HTML, PDF, and EPUB formats.
The manual is generated in English and in other available languages (currently only Spanish). For this, it is necessary to specify appropriate options in the cmake command as follows:
DOC_ALL: Generate in HTML, PDF, and EPUB formatsDOC_HTML: Generate in HTML formatDOC_PDF: Generate in PDF formatDOC_EPUB: Generate in EPUB formatLANG_ALL: Generate in all available languagesES: Generate the Spanish documentation
For example, the following command generates the documentation in all formats and in all languages.
cmake -D DOC_ALL=true -D LANG_ALL=true ..
As another example, the following command generates the English documentation in PDF.
cmake -D DOC_PDF=true ..
make doc
The resulting documentation will be generated in the doc directory of the build directory.
A pregenerated version of the documentation is available.
| HTML |
Alternatively, you can generate the English developer's documentation in HTML format.
For this, it is necessary to add the option DOC_DEV in the cmake command as follows:
cmake -D DOC_DEV=true ..
make doc_dev
The resulting HTML documentation will be generated in the doxygen directory of the build directory.