espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-16 12:02:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add pre upload script to deploy the docs before component upload

Browse Source
This commit is contained in:
David Cermak
2021-07-23 09:42:25 +02:00
parent c1b1330680
commit 918db0d2f1
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
components/esp_modem/docs/README.md
View File

@ -58,8 +58,7 @@ IP address changes.
Common use cases of the esp-modem are also listed as the examples: Common use cases of the esp-modem are also listed as the examples:
* `examples/pppos_client` -- simple client which reads some module properties and switches to the data mode to connect to a public mqtt broker. * `examples/pppos_client` -- simple client which reads some module properties and switches to the data mode to connect to a public mqtt broker.
* `examples/modem_console` -- is an example to exercise all possible module commands in a console application. * `examples/modem_console` -- is an example to exercise all possible module commands in a console application.
* `examples/ap_to_pppos` -- this example focuses on the network connectivity of the esp-modem and provides a WiFi AP * `examples/ap_to_pppos` -- this example focuses on the network connectivity of the esp-modem and provides a WiFi AP that forwards packets (and uses NAT) to and from the PPPoS connection.
that forwards packets (and uses NAT) to and from the PPPoS connection.
## Extensibility ## Extensibility

5
components/esp_modem/pre_upload.sh Normal file
View File

@ -0,0 +1,5 @@
apk add clang g++ doxygen
pip install breathe==4.29.0
cd components/esp_modem/docs/
./generate_docs
cd ../../..