mirror of
https://github.com/espressif/esp-protocols.git
synced 2025-07-14 19:16:32 +02:00
CI/Docs: Add jobs to deploy component docs
This commit is contained in:
35
.github/workflows/build-docs.yml
vendored
Normal file
35
.github/workflows/build-docs.yml
vendored
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
name: Docs build
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
docs_build:
|
||||||
|
name: Docs-Build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout esp-protocols
|
||||||
|
uses: actions/checkout@master
|
||||||
|
with:
|
||||||
|
persist-credentials: false
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Generate docs
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get -y install doxygen clang python3-pip
|
||||||
|
python -m pip install breathe recommonmark
|
||||||
|
cd $GITHUB_WORKSPACE/components/esp_modem/docs
|
||||||
|
./generate_docs
|
||||||
|
cd $GITHUB_WORKSPACE/docs
|
||||||
|
touch .nojekyll
|
||||||
|
echo '<a href="esp_modem/index.html">esp-modem</a>' > index.html
|
||||||
|
|
||||||
|
- name: Deploy generated docs
|
||||||
|
uses: JamesIves/github-pages-deploy-action@4.1.5
|
||||||
|
with:
|
||||||
|
branch: gh-pages
|
||||||
|
folder: docs
|
@ -16,7 +16,8 @@ copyright = u'2016 - 2021, Espressif Systems (Shanghai) Co., Ltd'
|
|||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
language = 'en'
|
language = 'en'
|
||||||
|
|
||||||
extensions = ['breathe']
|
extensions = ['breathe', 'recommonmark']
|
||||||
|
|
||||||
|
|
||||||
breathe_projects = {'esp_modem': 'xml'}
|
breathe_projects = {'esp_modem': 'xml'}
|
||||||
|
|
||||||
|
@ -17,7 +17,9 @@ cat ../include/generate/esp_modem_command_declare.inc | clang -E -P -xc -I../in
|
|||||||
doxygen
|
doxygen
|
||||||
|
|
||||||
# Generate the docs
|
# 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
|
# Cleanup the doxygen xml's and temporary headers
|
||||||
rm -rf xml esp_modem_api_commands.h esp_modem_dce.hpp cxx_api_links.rst
|
rm -rf xml esp_modem_api_commands.h esp_modem_dce.hpp cxx_api_links.rst
|
||||||
|
Reference in New Issue
Block a user