0.10.0 changelog #14
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 generation & update | |
| on: | |
| push: | |
| tags: | |
| - '*' | |
| branches: | |
| - develop | |
| - master | |
| pull_request: | |
| branches: | |
| - develop | |
| - master | |
| jobs: | |
| generate: | |
| name: Generate the documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install Python dependencies | |
| run: | | |
| pip install -r docs/requirements.txt | |
| - name: Generate the documentation | |
| run: (cd docs && make html) | |
| - name: Upload documentation bundle | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation | |
| path: docs/build/html/ | |
| deploy: | |
| name: Deploy the documentation on Github pages | |
| runs-on: ubuntu-latest | |
| needs: generate | |
| if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')) | |
| steps: | |
| - name: Download documentation bundle | |
| uses: actions/download-artifact@v4 | |
| - name: Deploy documentation on pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: documentation/ |