Developer documentation workflow¶
What you need to know¶
For developer documentation, we use Doxygen comments extensively throughout NEST.
After installing NEST, you can extract comments from the source code
with make docs
. A doxygen
folder with HTML files will be
generated in the doc
folder in your source directory.
Note
This workflow shows you how to create developer documentation for NEST. For the user documentation, please refer to our User documentation workflow.
Instructions¶
Install Doxygen and graphviz.
If you are a Linux user, type:
sudo apt install doxygen graphviz
For macOS, please use Homebrew:
brew install doxygen graphviz
Navigate to, or create a
build
directory. See Install NEST.Add the
-Dwith-devdoc=ON
flag to your regular CMake command:cmake -Dwith-devdoc=ON
Generate HTML:
make docs
Preview documentation:
cd doc/doxygen/html browser index.html