Compiling documentation manuals - nrc-cnrc/EGSnrc GitHub Wiki

It is possible to compile the documentation manuals locally, rather than using the online versions. This has the benefit of capturing documentation related to new developments if you are working on an experimental branch (e.g. the develop branch). In contrast, the online documentation is generally updated only at the same time as the master branch.

The documentation source files are located in $HEN_HOUSE/docs/src. Compilation requires doxygen, pdflatex, bibtex and makeindex.

To build all of the documentation, use the command make all. To build a single document, specify the name of the pirs document, e.g. make pirs509a-beamnrc.