ci: doc: generalize zoomin upload

So that further Sphinx+Doxygen docsets are easy to add.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

.github/workflows/docbuild.yml

@@ -110,43 +110,50 @@ jobs:
         if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
         working-directory: ncs/nrf
         run: |
-          mkdir doc/_build/html-doxygen
+          ROOT="$PWD"
 
-          # Zephyr APIs (Doxygen)
-          mv doc/_build/html/zephyr/doxygen/html doc/_build/html-doxygen/zephyr-apis
+          # Doxygen APIs combined with Sphinx
+          declare -a SPHINX_DOXYGEN=("zephyr")
 
-          cp doc/_zoomin/zephyr.apis.custom.properties doc/_build/html-doxygen/zephyr-apis/custom.properties
-          sed -i 's/__VERSION__/'"${VERSION}"'/g' doc/_build/html-doxygen/zephyr-apis/custom.properties
+          mkdir doc/_build/html-doxygen
 
-          cp doc/_zoomin/zephyr.apis.tags.yml doc/_build/html-doxygen/zephyr-apis/tags.yml
-          sed -i 's/__VERSION__/'"${VERSION}"'/g' doc/_build/html-doxygen/zephyr-apis/tags.yml
+          for docset in "${SPHINX_DOXYGEN[@]}"; do
+            OUTDIR=doc/_build/html-doxygen/$docset-apis
+            mv doc/_build/html/$docset/doxygen/html "$OUTDIR"
 
-          # NCS (Sphinx)
-          cp doc/_zoomin/ncs.custom.properties doc/_build/html/custom.properties
-          sed -i 's/__VERSION__/'"${VERSION}"'/g' doc/_build/html/custom.properties
+            # Populate custom.properties, tags.yml
+            cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
+            sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
 
-          cp doc/_zoomin/ncs.tags.yml doc/_build/html/tags.yml
-          sed -i 's/__VERSION__/'"${VERSION}"'/g' doc/_build/html/tags.yml
+            cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
+            sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
 
-          # Patch links from Zephyr (Sphinx) to Zephyr APIs (Doxygen)
-          find doc/_build/html/zephyr -type f -name "*.html" -exec \
-            sed -ri "/href=\"(.*)\/doxygen\/html\/(.*)\"/{s//href=\"\1\/..\/..\/..\/zephyr-apis-$VERSION\/page\/\2\"/; :a s/__/_/;ta; }" {} \;
+            # Patch links from Sphinx to Doxygen APIs
+            find doc/_build/html/$docset -type f -name "*.html" -exec \
+              sed -ri "/href=\"(.*)\/doxygen\/html\/(.*)\"/{s//href=\"\1\/..\/..\/..\/$docset-apis-$VERSION\/page\/\2\"/; :a s/__/_/;ta; }" {} \;
 
-          # Prepare archives
-          cd doc/_build/
+            pushd "$OUTDIR"
+            ARCHIVE="$docset-apis-$VERSION.zip"
+            zip -rq "$ARCHIVE" .
+            mv "$ARCHIVE" "$ROOT"
+            popd
+          done
 
-          cd html-doxygen/zephyr-apis
-          ARCHIVE="zephyr-apis-${VERSION}.zip"
-          zip -rq "${ARCHIVE}" .
-          mv "${ARCHIVE}" ../../../../
-          cd ../../
+          # NCS
+          OUTDIR=doc/_build/html
 
-          ARCHIVE="ncs-${VERSION}.zip"
-          cd html
-          zip -rq "${ARCHIVE}" .
-          mv "${ARCHIVE}" ../../../
-          cd ..
+          # Populate custom.properties, tags.yml
+          cp doc/_zoomin/ncs.custom.properties "$OUTDIR/custom.properties"
+          sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
+
+          cp doc/_zoomin/ncs.tags.yml "$OUTDIR/tags.yml"
+          sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
 
+          ARCHIVE="ncs-$VERSION.zip"
+          pushd "$OUTDIR"
+          zip -rq "$ARCHIVE" .
+          mv "$ARCHIVE" "$ROOT"
+          popd
       - name: Store
         if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
         uses: actions/upload-artifact@v4