1.4 Compiling Documentation

Documentation for Nektar++ is provided in a number of forms:

• User Guide (LaTeX, compiled to pdf or html)
• Source code documentation (Doxygen compiled to html)

1.4.1 Dependencies

To build the LaTeX documents (user guide or tutorials), the following dependencies are required:

• texlive-base
• texlive-latex-extra
• texlive-science
• texlive-fonts-recommended
• imagemagick

To build the Doxygen documentation, the following dependencies are required:

• doxygen
• graphviz

1.4.2 Compiling the User Guide

To compile the User Guide:

1. Configure the Nektar++ build tree as normal.
2. Run
   make user-guide-pdf

   to make the PDF version, or run

   make user-guide-html

   to make the HTML version.

1.4.3 Compiling the code documentation

To compile the code documentation enable the NEKTAR_BUILD_DOC option in the ccmake configuration tool.

You can then compile the HTML code documentation using: