diff --git a/doc/src/README.md b/doc/src/README.md new file mode 100644 index 0000000000000000000000000000000000000000..877eb9dd0f8ee2f63690d34b5b40e7b372a5b146 --- /dev/null +++ b/doc/src/README.md @@ -0,0 +1,12 @@ +# Folder instructions + +This directory contains the material to build the project documentation with `doxygen`. + +## Instructions + +The project documentation is managed by `doxygen`, a documentation generator that is able to extract documents directly from properly formatted comment sections of the source code. To build a local instance of project documents, make sure that you have `doxygen` installed, then `cd` into the document source folder (the folder containing the `conf.dox` file, specifically `np_tmcode/doc/src`) and then run: +``` +doxygen conf.dox +``` + +`doxygen` will automatically build the HTML structure to cover all the documented source code and it will additionally provide the fundamental structure to prepare a LaTeX formatted version of the documents. These two outputs will be placed, respectively, under the folders `np_tmcode/doc/build/html` and `np_tmcode/doc/build/latex`. \ No newline at end of file