DOCS-2901: Fleet management api code QA (#738) #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 docs | |
| on: | |
| workflow_dispatch: | |
| push: | |
| paths: | |
| - "src/viam/**" | |
| - "docs/**" | |
| - "README.md" | |
| branches: [main] | |
| jobs: | |
| generate-docs: | |
| if: github.repository_owner == 'viamrobotics' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Install Poetry | |
| uses: snok/install-poetry@v1 | |
| - name: Install package | |
| run: make install | |
| - name: Generate docs | |
| run: | | |
| poetry run python3 -m docs.examples._server & | |
| poetry run python3 -m examples.server.v1.server 0.0.0.0 9091 & | |
| sleep 2 | |
| make documentation | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: html-docs | |
| path: docs/_build/html/ | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/html | |
| publish_branch: docs-gh_pages | |
| cname: python.viam.dev |