Merge pull request #19 from david-cermak/bugfix/fix_docs_build

CI: Fix docs build failure

.github/workflows/publish-docs-component-websockets.yml

@@ -1,39 +0,0 @@
-name: Docs and Publish Websockets
-
-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 git
-          sudo git clone https://github.com/espressif/esp-idf
-          python -m pip install breathe recommonmark
-          python -m pip install -r esp-idf/docs/requirements.txt
-          cd $GITHUB_WORKSPACE/components/esp_websocket_client/docs
-          ./generate_docs
-          mkdir -p $GITHUB_WORKSPACE/docs/esp_websocket_client
-          cp -r html/. $GITHUB_WORKSPACE/docs/esp_websocket_client
-          cd $GITHUB_WORKSPACE/docs
-          touch .nojekyll
-          echo '<a href="esp_websocket_client/index.html">esp-websocket-client</a>' >> index.html
-
-      - name: Deploy generated docs.
-        uses: JamesIves/github-pages-deploy-action@4.1.5
-        with:
-          branch: gh-pages
-          folder: docs

.github/workflows/publish-docs-component.yml

@@ -21,20 +21,25 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get -y install doxygen clang python3-pip
-          python -m pip install breathe recommonmark
+          python -m pip install breathe recommonmark esp-docs==0.2.1
           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/components/esp_websocket_client/docs
+          ./generate_docs
+          mkdir -p $GITHUB_WORKSPACE/docs/esp_websocket_client
+          cp -r html/. $GITHUB_WORKSPACE/docs/esp_websocket_client
           cd $GITHUB_WORKSPACE/docs
           touch .nojekyll
           echo '<a href="esp_modem/index.html">esp-modem</a>' > index.html
+          echo '<a href="esp_websocket_client/index.html">esp-websocket-client</a>' >> index.html
+
 
       - name: Upload components to component service
         uses: espressif/github-actions/upload_components@master
         with:
-          directories: "components/esp_modem"
-          name: "esp_modem"
+          directories: "components/esp_modem;components/esp_websocket_client"
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
 

components/esp_websocket_client/docs/conf_common.py

@@ -7,7 +7,7 @@ extensions += ['sphinx_copybutton',
                ]
 
 # link roles config
-github_repo = 'espressif/esp-idf'
+github_repo = 'espressif/esp-protocols'
 
 # context used by sphinx_idf_theme
 html_context['github_user'] = 'espressif'

components/esp_websocket_client/docs/en/conf.py

@@ -16,7 +16,7 @@ except ImportError:
     from conf_common import *  # noqa: F403,F401
 
 # General information about the project.
-project = u'ESP-Docs'
+project = u'ESP-Protocols'
 copyright = u'2016 - 2022, Espressif Systems (Shanghai) Co., Ltd'
 
 # The language for content autogenerated by Sphinx. Refer to documentation