minor updates to docs and workflows #5
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: "Deploy Package Documentation to Pages" | |
| on: | |
| push: | |
| branches: [main] # branch to trigger deployment | |
| workflow_dispatch: | |
| jobs: | |
| pages: | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| contents: write | |
| steps: | |
| - id: deployment | |
| uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892 # v3.1 | |
| with: | |
| publish: false | |
| documentation_path: ./docs | |
| pyproject_extras: docs | |
| - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ${{ steps.deployment.outputs.artifact }} | |
| publish_branch: gh-pages # default: gh-pages | |
| commit_message: ${{ github.event.head_commit.message }} | |