Deploy docs to Pages #4
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 docs to GitHub Pages | |
name: Deploy docs to Pages | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["main"] | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
concurrency: | |
group: "pages" | |
cancel-in-progress: false | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/[email protected] | |
- name: Configure GitHub Pages | |
id: pages | |
uses: actions/[email protected] | |
- name: Get tool versions | |
id: tool_versions | |
run: echo "python=$(grep --only-matching --perl-regexp 'python \K\S+' .tool-versions)" >> $GITHUB_OUTPUT | |
- name: Setup Python | |
uses: actions/[email protected] | |
with: | |
python-version: ${{ steps.tool_versions.outputs.python }} | |
- name: Install dependencies | |
run: pip install -r requirements.txt | |
- name: make html | |
run: | | |
cd docs | |
make html | |
- name: Upload artifact | |
uses: actions/[email protected] | |
with: | |
path: docs/build/html | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/[email protected] |