An open API service indexing awesome lists of open source software.

https://github.com/cgal/cgal-documentation-dockerfile

Docker file for the generation of the CGAL documentation using Doxygen
https://github.com/cgal/cgal-documentation-dockerfile

Last synced: 3 days ago
JSON representation

Docker file for the generation of the CGAL documentation using Doxygen

Awesome Lists containing this project

README

          

cgal-doxygen-image
==================

This Docker image can be used to build the documentation of CGAL.

It requires a single user mounted volume containing the CGAL tree to be used, `/mnt/cgal`.

Example Usage:

#call the script
`./generate_documentation.sh `

where

- `path_to_image` is the absolute path to the directory containing the dockerfile
- `path_to_cgal` is the absolute path to either:
- the root directory of a CGAL release tarball, or
- the root directory of a CGAL Git repository.
- `path_to_publish_dir` is the absolute path to the output directory, that will contain the 3 versions and the result of the comparison.