Document how to use the mkapi tool in the readme. #52
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check API docs | |
| on: | |
| push: | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| container: alpine:edge | |
| runs-on: ubuntu-latest | |
| if: github.ref != 'refs/heads/master' | |
| env: | |
| MKAPI_BRANCHES: insp4 master | |
| MKAPI_TAGS: v4 v5 | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install dependencies | |
| run: |- | |
| apk add doxygen git python3 py3-pip | |
| pip3 install --break-system-packages jinja2 | |
| - name: Build API docs | |
| run: |- | |
| ./mkapi |