Update README.md #170
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: | |
| - main | |
| jobs: | |
| docs: | |
| if: ${{ !contains(github.event.head_commit.message, 'Bump version') }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/[email protected] | |
| with: | |
| persist-credentials: false | |
| - uses: ./.github/actions/dependencies | |
| - name: Generate Docs | |
| run: | | |
| pdm run make gen-docs | |
| touch docs/_build/html/.nojekyll | |
| - name: Publish Docs | |
| uses: JamesIves/[email protected] | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BASE_BRANCH: main # The branch the action should deploy from. | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: docs/_build/html/ # The folder the action should deploy. | |