1# Doxygen 2 3To generate all the documentation run the following from this directory: 4 5 doxygen Doxyfile 6 7The resulting output goes to 8 9 /tmp/doxygen 10 11To view those file locally in your browser run: 12 13 cd /tmp/doxygen/html; python3 -m http.server 8000 14 15and visit 16 17 http://localhost:8000 18 19If you want to have the documentation regenerated on every save then you can 20install `entr` and run the following from this directory: 21 22 find ../../include/ ../../src/ . | entr doxygen ./Doxyfile 23 24## Install 25 26For a linux desktop you can install the doxygen tool via: 27 28 sudo apt install doxygen 29