Docs #462
Workflow file for this run
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: Docs | |
| on: [push, workflow_dispatch] | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - run: npm install -g @mermaid-js/mermaid-cli | |
| - name: Install Project | |
| run: make install | |
| - name: Generate Docs | |
| run: make docs | |
| - name: Deploy Docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'workflow_dispatch' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/html/ | |
| force_orphan: true |