Documentation #39
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "docs/*" | |
| - "**.md" | |
| - "mkdocs.yml" | |
| workflow_dispatch: | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v2 | |
| with: | |
| python-version: 3.x | |
| - run: cp proto/apidocs.swagger.json docs/reference/apidocs.json | |
| - run: pip install mkdocs-material | |
| - run: pip install mkdocs-git-revision-date-plugin | |
| - run: pip install mkdocs-render-swagger-plugin | |
| - run: pip install mkdocs-mermaid2-plugin | |
| - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com' | |
| - name: Publish docs | |
| run: mkdocs gh-deploy --force |