From f32c7ab3cb1cca10f7f91c860dba50527859e35f Mon Sep 17 00:00:00 2001 From: Gaute Svanes Lunde Date: Tue, 17 Jan 2023 22:25:34 +0100 Subject: [PATCH] Add docbuild workflow for PRs (#24468) * workflows: add docbuild to PRs Added the docbuild workflow to PRs to inform contributors whether any changes will break the documentation build. Also limited the deploy step to only run on pushes to the master branch. Added the `--keep-going` flag to the Sphinx makefile to list all errors instead of stopping at the first one. Signed-off-by: Gaute Svanes Lunde * doc: Fix broken references Fixed some broken references to non-existing section "Running Pigweed RPC console" and the path to `docs/guides/silabs_efr32_software_update.md` Signed-off-by: Gaute Svanes Lunde Signed-off-by: Gaute Svanes Lunde --- .github/workflows/docbuild.yaml | 12 ++++++++++-- docs/Makefile | 2 +- .../light-switch-app/silabs/SiWx917/README.md | 16 ++-------------- examples/lock-app/silabs/SiWx917/README.md | 14 +------------- examples/window-app/silabs/SiWx917/README.md | 16 +--------------- 5 files changed, 15 insertions(+), 45 deletions(-) diff --git a/.github/workflows/docbuild.yaml b/.github/workflows/docbuild.yaml index 4e2d9bc22325e3..5e5db83f8f00dc 100644 --- a/.github/workflows/docbuild.yaml +++ b/.github/workflows/docbuild.yaml @@ -1,6 +1,14 @@ name: Documentation Build on: + pull_request: + types: [opened, synchronize, reopened] + branches: + - master + paths: + - '.github/workflows/docbuild.yaml' + - '**.md' + - 'docs/**' push: branches: - master @@ -9,7 +17,7 @@ permissions: contents: write jobs: - build-and-deploy: + build-and-publish: runs-on: ubuntu-latest steps: @@ -39,7 +47,7 @@ jobs: make html touch _build/html/.nojekyll - name: Deploy to gh-pages - if: github.repository == 'project-chip/connectedhomeip' + if: github.repository == 'project-chip/connectedhomeip' && github.event_name == 'push' && github.ref_name == 'master' uses: peaceiris/actions-gh-pages@v3 with: deploy_key: ${{ secrets.DOXYGEN_DEPLOY_KEY }} diff --git a/docs/Makefile b/docs/Makefile index 30826e465ad549..0d2d810e4769da 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= -W -c . -d _build/doctrees +SPHINXOPTS ?= -W --keep-going -c . -d _build/doctrees SPHINXBUILD ?= sphinx-build SOURCEDIR = _build/src BUILDDIR = _build diff --git a/examples/light-switch-app/silabs/SiWx917/README.md b/examples/light-switch-app/silabs/SiWx917/README.md index 3a72765e663796..b08f29749e09cd 100644 --- a/examples/light-switch-app/silabs/SiWx917/README.md +++ b/examples/light-switch-app/silabs/SiWx917/README.md @@ -32,8 +32,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24. > release with added tools and documentation. > [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases) - - ## Introduction The EFR32 light switch example provides a baseline demonstration of a on-off @@ -53,8 +51,6 @@ The light switch example is intended to serve both as a means to explore the workings of Matter as well as a template for creating real products based on the Silicon Labs platform. - - ## Building - Download the @@ -181,15 +177,13 @@ Silicon Labs platform. $ gn gen out/debug --args='import("//with_pw_rpc.gni")' $ ninja -C out/debug - [Running Pigweed RPC console](#running-pigweed-rpc-console) + [Running Pigweed RPC console](#running-rpc-console) For more build options, help is provided when running the build script without arguments ./scripts/examples/gn_efr32_example.sh - - ## Flashing the Application - On the command line: @@ -199,8 +193,6 @@ arguments - Or with the Ozone debugger, just load the .out file. - - ## Viewing Logging Output The example application is built to use the SEGGER Real Time Transfer (RTT) @@ -249,8 +241,6 @@ combination with JLinkRTTClient as follows: $ JLinkRTTClient - - ## Running the Complete Example - It is assumed here that you already have an OpenThread border router @@ -385,8 +375,6 @@ combination with JLinkRTTClient as follows: #Add Ipv6 route on PC(Linux) \$ sudo ip route add /64 via 2002::2 - - ## Running RPC console - As part of building the example with RPCs enabled the chip_rpc python @@ -432,7 +420,7 @@ tracking code inside the `trackAlloc` and `trackFree` function For the description of Software Update process with EFR32 example applications see -[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md) +[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md) ## Building options diff --git a/examples/lock-app/silabs/SiWx917/README.md b/examples/lock-app/silabs/SiWx917/README.md index a681df76cc6d45..5944a5f8afe767 100644 --- a/examples/lock-app/silabs/SiWx917/README.md +++ b/examples/lock-app/silabs/SiWx917/README.md @@ -27,8 +27,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24. > release with added tools and documentation. > [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases) - - ## Introduction The EFR32 lock example provides a baseline demonstration of a door lock control @@ -48,8 +46,6 @@ The lighting example is intended to serve both as a means to explore the workings of Matter as well as a template for creating real products based on the Silicon Labs platform. - - ## Building - Download the @@ -189,8 +185,6 @@ Mac OS X $ ninja -C out/debug ``` - [Running Pigweed RPC console](#running-pigweed-rpc-console) - For more build options, help is provided when running the build script without arguments @@ -198,8 +192,6 @@ arguments ./scripts/examples/gn_efr32_example.sh ``` - - ## Flashing the Application - On the command line: @@ -211,8 +203,6 @@ arguments - Or with the Ozone debugger, just load the .out file. - - ## Viewing Logging Output The example application is built to use the SEGGER Real Time Transfer (RTT) @@ -271,8 +261,6 @@ combination with JLinkRTTClient as follows: $ JLinkRTTClient ``` - - ## Running the Complete Example - It is assumed here that you already have an OpenThread border router @@ -413,7 +401,7 @@ tracking code inside the `trackAlloc` and `trackFree` function For the description of Software Update process with EFR32 example applications see -[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md) +[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md) ## Building options diff --git a/examples/window-app/silabs/SiWx917/README.md b/examples/window-app/silabs/SiWx917/README.md index dda149285a8f91..58691ca93e857a 100644 --- a/examples/window-app/silabs/SiWx917/README.md +++ b/examples/window-app/silabs/SiWx917/README.md @@ -26,8 +26,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24. > release with added tools and documentation. > [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases) - - ## Introduction The EFR32 window-covering example provides a baseline demonstration of a Window @@ -48,8 +46,6 @@ The window-covering example is intended to serve both as a means to explore the workings of Matter as well as a template for creating real products based on the Silicon Labs platform. - - ## Building - Download the @@ -145,15 +141,11 @@ Silicon Labs platform. $ gn gen out/debug --args='import("//with_pw_rpc.gni")' $ ninja -C out/debug - [Running Pigweed RPC console](#running-pigweed-rpc-console) - For more build options, help is provided when running the build script without arguments ./scripts/examples/gn_efr32_example.sh - - ## Flashing the Application - On the command line: @@ -163,8 +155,6 @@ arguments - Or with the Ozone debugger, just load the .out file. - - ## Viewing Logging Output The example application is built to use the SEGGER Real Time Transfer (RTT) @@ -213,8 +203,6 @@ combination with JLinkRTTClient as follows: $ JLinkRTTClient - - ## Running the Complete Example - It is assumed here that you already have an OpenThread border router @@ -344,13 +332,11 @@ combination with JLinkRTTClient as follows: # Add Ipv6 route on PC (Linux) $ sudo ip route add /64 via 2002::2 - - ## OTA Software Update For the description of Software Update process with EFR32 example applications see -[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md) +[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md) ## Building options