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

CI/Docs: Add jobs to deploy component docs

Browse Source
This commit is contained in:
David Cermak
2021-11-12 12:01:34 +01:00
parent 23dbdb584e
commit b9ff1e4e12
3 changed files with 40 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
components/esp_modem/docs/conf.py
View File

@ -16,7 +16,8 @@ copyright = u'2016 - 2021, Espressif Systems (Shanghai) Co., Ltd'
# for a list of supported languages.
language = 'en'
extensions = ['breathe']
extensions = ['breathe', 'recommonmark']
breathe_projects = {'esp_modem': 'xml'}

4
components/esp_modem/docs/generate_docs
View File

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