DOC: add docs badge to README #3
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: Docs Deploy | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| docs-deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: docs-deploy | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download Artifact | |
| uses: dawidd6/action-download-artifact@v6 | |
| with: | |
| workflow: docs-build.yml | |
| name: docs-build | |
| path: docs/build/ | |
| # Note, the gh-pages deployment requires setting up a SSH deploy key. | |
| # See | |
| # https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key- | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: docs/build/ | |
| ssh-key: ${{ secrets.DEPLOY_KEY }} | |
| force: no |