skia2/tools/doxygen/README.md
Joe Gregorio 87496d3cc9 Fix doxygen README.md to use python3.
Change-Id: Ie4ce9604f3c00f31a1f0117afeaa0ea6f30e9bd8
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/515719
Reviewed-by: Ravi Mistry <rmistry@google.com>
2022-03-04 14:21:35 +00:00

598 B

Doxygen

To generate all the documentation run the following from this directory:

doxygen Doxyfile

The resulting output goes to

/tmp/doxygen

To view those file locally in your browser run:

cd /tmp/doxygen/html; python3 -m http.server 8000

and visit

http://localhost:8000

If you want to have the documentation regenerated on every save then you can install entr and run the following from this directory:

find  ../../include/ ../../src/ . | entr doxygen ./Doxyfile

Install

For a linux desktop you can install the doxygen tool via:

sudo apt install doxygen