Documentation - DLR-AMR/t8code GitHub Wiki

Documentation

t8code uses Doxygen to generate the code documentation. You can find the documentation of our releases on the t8code website.

Follow the steps below to create the documentation locally.

• Set the value of the build option T8CODE_BUILD_DOCUMENTATION to ON.
• Build the target Doxygen using

make Doxygen

and then find the generated files in the /doc subdirectory of your build folder.

• For example, open the doc/html/index.html file to view the documentation.