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

CI/Docs: Generate docs locally before uploading to registry

Browse Source
This commit is contained in:
David Cermak
2021-11-12 16:24:41 +01:00
parent b9ff1e4e12
commit 2c21aa1113
4 changed files with 20 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/esp_modem/docs/generate_docs
View File

@ -17,9 +17,7 @@ cat ../include/generate/esp_modem_command_declare.inc | clang -E -P -xc -I../in
doxygen
# Generate the docs
mkdir -p ../../../docs/esp_modem
python -u -m sphinx.cmd.build -b html . ../../../docs/esp_modem
python -u -m sphinx.cmd.build -b html . html
# Cleanup the doxygen xml's and temporary headers
rm -rf xml esp_modem_api_commands.h esp_modem_dce.hpp cxx_api_links.rst

11
components/esp_modem/pre_upload.sh
View File

@ -1,5 +1,8 @@
apk add clang g++ doxygen
pip install breathe==4.29.0
cd components/esp_modem/docs/
#!/bin/bash
apt-get update
apt-get -y install doxygen clang python3-pip
python -m pip install breathe recommonmark
pushd components/esp_modem/docs
./generate_docs
cd ../../..
popd