|
| 1 | +# Simple workflow for deploying static content to GitHub Pages |
| 2 | +name: Deploy static content to Pages |
| 3 | + |
| 4 | +on: |
| 5 | + # Runs on pushes targeting the default branch |
| 6 | + push: |
| 7 | + branches: ["deploy"] |
| 8 | + |
| 9 | + # Allows you to run this workflow manually from the Actions tab |
| 10 | + workflow_dispatch: |
| 11 | + |
| 12 | +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages |
| 13 | +permissions: |
| 14 | + contents: read |
| 15 | + pages: write |
| 16 | + id-token: write |
| 17 | + |
| 18 | +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. |
| 19 | +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. |
| 20 | +concurrency: |
| 21 | + group: "pages" |
| 22 | + cancel-in-progress: false |
| 23 | + |
| 24 | +jobs: |
| 25 | + # Single deploy job since we're just deploying |
| 26 | + deploy: |
| 27 | + environment: |
| 28 | + name: github-pages |
| 29 | + url: ${{ steps.deployment.outputs.page_url }} |
| 30 | + runs-on: ubuntu-latest |
| 31 | + steps: |
| 32 | + - name: Checkout |
| 33 | + uses: actions/checkout@v4 |
| 34 | + - name: Setup Pages |
| 35 | + uses: actions/configure-pages@v5 |
| 36 | + - name: Set up Python 3.8 |
| 37 | + uses: actions/setup-python@v5 |
| 38 | + with: |
| 39 | + python-version: 3.8 |
| 40 | + - name: "Run Reference Documentation Generation" |
| 41 | + run: | |
| 42 | + sudo apt install pandoc |
| 43 | + pip install -U pip setuptools wheel |
| 44 | + pip install -r docs/requirements.txt |
| 45 | + sphinx-build -a docs/ docs/_build/html |
| 46 | + - name: Upload artifact |
| 47 | + uses: actions/upload-pages-artifact@v3 |
| 48 | + with: |
| 49 | + # Upload entire repository |
| 50 | + path: './docs/_build/html' |
| 51 | + - name: Deploy to GitHub Pages |
| 52 | + id: deployment |
| 53 | + uses: actions/deploy-pages@v4 |
0 commit comments