From 2c21aa11139a7e8b3eb5b2bcc64f63dad37de9c2 Mon Sep 17 00:00:00 2001
From: David Cermak <cermak@espressif.com>
Date: Fri, 12 Nov 2021 16:24:41 +0100
Subject: [PATCH] CI/Docs: Generate docs locally before uploading to registry

---
 ...ld-docs.yml => publish-docs-component.yml} | 14 +++++++++++--
 .github/workflows/upload_component.yml        | 21 -------------------
 components/esp_modem/docs/generate_docs       |  4 +---
 components/esp_modem/pre_upload.sh            | 11 ++++++----
 4 files changed, 20 insertions(+), 30 deletions(-)
 rename .github/workflows/{build-docs.yml => publish-docs-component.yml} (63%)
 delete mode 100644 .github/workflows/upload_component.yml

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/publish-docs-component.yml
similarity index 63%
rename from .github/workflows/build-docs.yml
rename to .github/workflows/publish-docs-component.yml
index 1ce5c2b96..511643410 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/publish-docs-component.yml
@@ -1,4 +1,4 @@
-name: Docs build
+name: Docs and Publish
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
 
 jobs:
   docs_build:
-    name: Docs-Build
+    name: Docs-Build-And-Upload
     runs-on: ubuntu-latest
 
     steps:
@@ -24,10 +24,20 @@ jobs:
           python -m pip install breathe recommonmark
           cd $GITHUB_WORKSPACE/components/esp_modem/docs
           ./generate_docs
+          mkdir -p $GITHUB_WORKSPACE/docs/esp_modem
+          cp -r html/. $GITHUB_WORKSPACE/docs/esp_modem
           cd $GITHUB_WORKSPACE/docs
           touch .nojekyll
           echo '<a href="esp_modem/index.html">esp-modem</a>' > index.html
 
+      - name: Upload components to component service
+        uses: espressif/github-actions/upload_components@master
+        with:
+          directories: "components/esp_modem"
+          name: "esp_modem"
+          namespace: "espressif"
+          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
+
       - name: Deploy generated docs
         uses: JamesIves/github-pages-deploy-action@4.1.5
         with:
diff --git a/.github/workflows/upload_component.yml b/.github/workflows/upload_component.yml
deleted file mode 100644
index a7f165d62..000000000
--- a/.github/workflows/upload_component.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-name: Push components to Espressif Component Service
-
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  upload_components:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-
-      - name: Upload components to component service
-        uses: espressif/github-actions/upload_components@master
-        with:
-          directories: "components/esp_modem"
-          name: "esp_modem"
-          namespace: "espressif"
-          api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
-
diff --git a/components/esp_modem/docs/generate_docs b/components/esp_modem/docs/generate_docs
index 41855a97a..8a0c2715b 100755
--- a/components/esp_modem/docs/generate_docs
+++ b/components/esp_modem/docs/generate_docs
@@ -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
diff --git a/components/esp_modem/pre_upload.sh b/components/esp_modem/pre_upload.sh
index 77f6b2586..a988b8d82 100644
--- a/components/esp_modem/pre_upload.sh
+++ b/components/esp_modem/pre_upload.sh
@@ -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