Update README.md #26
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: doc | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| release: | |
| types: [ published ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Install build tools | |
| run: | | |
| python -m pip install hatch | |
| - name: Build the Sphinx documentation | |
| run: | | |
| hatch run doc:build | |
| - name: Deploy to GitHub Pages | |
| if: github.event_name == 'release' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ github.token }} | |
| publish_dir: ./doc/build/html |