Simple documentation building example that builds documentation for all targets together with an API-reference generated by doxygen.
For more information please see ESP Docs:
- Building Documentation
- Writing Documentation
- API Documentation Template
- ESP-DOCS Add-Ons and Extensions Reference
-
To ensure you can build the documentation, create a docker image for building the documentation
docker build -t esp-docs .(from within this directory) ordocker build -t esp-docs docfrom within the top-level project / espp directory. -
To build the documentation, simply run
./build_docs.shfrom within the top-level project / espp directory.