diff --git a/.github/workflows/publish-docs-component.yml b/.github/workflows/publish-docs-component.yml new file mode 100644 index 000000000..511643410 --- /dev/null +++ b/.github/workflows/publish-docs-component.yml @@ -0,0 +1,45 @@ +name: Docs and Publish + +on: + push: + branches: + - master + +jobs: + docs_build: + name: Docs-Build-And-Upload + 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 + mkdir -p $GITHUB_WORKSPACE/docs/esp_modem + cp -r html/. $GITHUB_WORKSPACE/docs/esp_modem + cd $GITHUB_WORKSPACE/docs + touch .nojekyll + echo 'esp-modem' > 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: + branch: gh-pages + folder: docs 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/conf.py b/components/esp_modem/docs/conf.py index 4bfa938be..8a41ca248 100644 --- a/components/esp_modem/docs/conf.py +++ b/components/esp_modem/docs/conf.py @@ -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'} 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