Edit README #4
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: | |
| - master | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # fetch the whole history to get tags | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Build documentation 🔨 | |
| run: make html | |
| working-directory: docs | |
| # allow to serve dirs starting with _ (_static for example) | |
| - name: Add .nojekyll | |
| run: touch .nojekyll | |
| working-directory: docs/build/html | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@releases/v4 | |
| with: | |
| # note: folder doesn't care about the job's working directory | |
| folder: docs/build/html |