diff --git a/.github/workflows/sphinx-check-warnings.yml b/.github/workflows/sphinx-check-warnings.yml new file mode 100644 index 00000000000..d21251e2cef --- /dev/null +++ b/.github/workflows/sphinx-check-warnings.yml @@ -0,0 +1,37 @@ +name: "Check Page for Warnings" +on: + workflow_dispatch: + push: + branches: + - master + schedule: + # Run every morning to ensure component documentation is up to date on deployment + - cron: '23 5 * * *' + pull_request: # only runs up through build of sphinx + +jobs: + build-deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-python@v4 + with: + python-version: '3.8' + cache: 'pip' + - name: Install Python dependencies + run: | + python -m pip install --upgrade pip + pip install --upgrade --requirement requirements.txt + - name: Install generate_parameter_library + run: | + cd + git clone https://github.com/PickNikRobotics/generate_parameter_library.git + cd generate_parameter_library/generate_parameter_library_py/ + python -m pip install . + - name: Build multiversion considering warnings as errors + run: | + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + make multiversion-with-errors diff --git a/Makefile b/Makefile index b5e9945aa38..0946d7dff6a 100644 --- a/Makefile +++ b/Makefile @@ -55,6 +55,17 @@ multiversion: Makefile @echo Step 4: Create correct index @echo "" > "$(BUILDDIR)"/html/index.html +multiversion-with-errors: Makefile + @echo Building multi version documentation without API + @echo Step 1: Creating temporary commits + ./make_help_scripts/add_tmp_commits + @echo Step 2: Build multi version documentation + sphinx-multiversion $(SPHINXOPTS) -W --keep-going $(SOURCEDIR) $(BUILDDIR)/html + @echo Step 3: Deleting temporary commits + ./make_help_scripts/delete_tmp_commits + @echo Step 4: Create correct index + @echo "" > "$(BUILDDIR)"/html/index.html + multiversion-with-api: Makefile @echo Building multi version documentation with API @echo Step 1: Creating temporary commits diff --git a/README.md b/README.md index 1b60ab908e0..8cac04a5134 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Status -[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml) +[![Build & Deploy Page](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml/badge.svg)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-make-page.yml)[![Sphinx Warnings](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml/badge.svg?branch=master)](https://github.com/ros-controls/control.ros.org/actions/workflows/sphinx-check-warnings.yml) # control.ros.org