better instructions for prerequisites #329
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: Build Documentation | |
| on: [push] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| name: Check out source-code repository | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| - name: Install pip | |
| run: | | |
| python -m pip install --upgrade pip | |
| - name: Install doc dependencies | |
| run: | | |
| pip install -r docs/requirements.txt | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| make html | |
| - name: Deploy | |
| if: ${{ github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'}} | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html |