From 5063cdd797eab3fe77ef648cbae4c93de7b9c8dc Mon Sep 17 00:00:00 2001 From: Pedro Minatel Date: Mon, 15 Jan 2024 14:45:22 +0000 Subject: [PATCH] [Docs] Fix on the documentation preview deploy CI (#9109) * Fix on the Docs deploy CI * Removed the docs build badge (RTD) * Update .github/workflows/docs_build.yml Co-authored-by: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> --------- Co-authored-by: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> --- .github/workflows/docs_build.yml | 10 +++++++++- .github/workflows/docs_deploy.yml | 19 +++++++++++-------- .github/workflows/docs_preview.yml | 10 ++++++---- README.md | 3 +-- docs/requirements.txt | 14 +++++++++++++- 5 files changed, 40 insertions(+), 16 deletions(-) diff --git a/.github/workflows/docs_build.yml b/.github/workflows/docs_build.yml index c18120c079f..2de8f347265 100644 --- a/.github/workflows/docs_build.yml +++ b/.github/workflows/docs_build.yml @@ -1,6 +1,13 @@ name: Documentation Build and Deploy CI on: + push: + branches: + - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' pull_request: paths: - 'docs/**' @@ -9,7 +16,7 @@ on: jobs: build-docs: - name: Build Documentation + name: Build ESP-Docs runs-on: ubuntu-22.04 defaults: run: @@ -35,3 +42,4 @@ jobs: with: name: docs path: docs + diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml index ebc8acac792..7a1123454ae 100644 --- a/.github/workflows/docs_deploy.yml +++ b/.github/workflows/docs_deploy.yml @@ -1,4 +1,4 @@ -name: Documentation Build and Deploy Production CI +name: Documentation Build and Production Deploy CI on: push: @@ -11,27 +11,28 @@ on: jobs: deploy-prod-docs: - name: Deploy Documentation Production + name: Deploy Documentation on Production runs-on: ubuntu-22.04 defaults: run: shell: bash steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: submodules: true - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4 with: python-version: '3.10' - - name: Deploy Preview + - name: Deploy Documentation env: # Deploy to production server - DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/" + # DOCS_BUILD_DIR: "./docs/_build/" DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }} DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }} - DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} + DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }} + # Deploy to preview server run: | sudo apt update sudo apt install python3-pip python3-setuptools @@ -43,4 +44,6 @@ jobs: echo "Building the Docs..." cd ./docs && build-docs -l en echo "Deploy the Docs..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs deploy-docs diff --git a/.github/workflows/docs_preview.yml b/.github/workflows/docs_preview.yml index 41de91838b3..3923839ada0 100644 --- a/.github/workflows/docs_preview.yml +++ b/.github/workflows/docs_preview.yml @@ -1,4 +1,4 @@ -name: Documentation Build and Deploy CI +name: Documentation Build and Preview Deploy CI on: push: @@ -11,7 +11,7 @@ on: jobs: deploy-preview-docs: - name: Deploy Documentation Preview + name: Deploy Documentation runs-on: ubuntu-22.04 defaults: run: @@ -26,12 +26,12 @@ jobs: - name: Deploy Preview env: # Deploy to preview server - DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/" + # DOCS_BUILD_DIR: "./docs/_build" DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }} DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }} DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }} - DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }} + DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }} run: | sudo apt update sudo apt install python3-pip python3-setuptools @@ -43,4 +43,6 @@ jobs: echo "Building the Docs..." cd ./docs && build-docs -l en echo "Deploy the Docs..." + export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/ + cd $GITHUB_WORKSPACE/docs deploy-docs diff --git a/README.md b/README.md index 09556346255..09daae01ca0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Arduino core for the ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2 -![Build Status](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![Documentation Status](https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest)](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest) -[![External Libraries Test](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule)](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md) +![Build Status](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![External Libraries Test](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule)](https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md) ### Need help or have a question? Join the chat at [Gitter](https://gitter.im/espressif/arduino-esp32) or [open a new Discussion](https://github.com/espressif/arduino-esp32/discussions) diff --git a/docs/requirements.txt b/docs/requirements.txt index 97b552574b9..7c819ff0836 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,15 @@ esp-docs==1.4.* sphinx-copybutton==0.5.0 -sphinx-tabs==3.2.0 \ No newline at end of file +sphinx-tabs==3.2.0 +sphinxcontrib-actdiag==3.0.0 +sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-blockdiag==3.0.0 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-nwdiag==2.0.0 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-seqdiag==3.0.0 +sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-svg2pdfconverter==1.2.0 +sphinxcontrib-wavedrom==3.0.4