init docs #1
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
| # Build and Deploy Sphinx Docs to GitHub Pages | |
| # Workflow for building sphinx documentation remotely | |
| # and deploying the static HTML to a GitHub Pages site. | |
| # Note this approach does not require the static HTML | |
| # files to be stored/pushed/committed to an alternate | |
| # pages branch or anything like that. It uses GitHub | |
| # Action artifacts... | |
| name: Deploy Docs | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| release: | |
| types: | |
| - published | |
| push: | |
| branches: | |
| - main | |
| - dev | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: sphinx-notes/pages@v3 |