Update build-api-docs.yml #2
This file contains 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: Generate API docs and deploy to GitHub Pages | |
| on: | |
| # Automatically trigger when push to main branch | |
| push: | |
| # Enable running workflow manually from GitHub Actions | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| generate-api-docs: | |
| name: Generate API Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Generate API docs and deploy to GitHub Pages | |
| uses: msayson/[email protected] | |
| with: | |
| api-configs: |- | |
| [ | |
| { | |
| "openapi-json-filepath": "doc/openapi/public_api.yml", | |
| "api-doc-filepath": "latest/docs.html" | |
| } | |
| ] | |
| api-docs-dir: docs |