Skip to content

Commit

Permalink
Add workflow for Github pages
Browse files Browse the repository at this point in the history
Signed-off-by: Charlie Street <me@charliestreet.net>
  • Loading branch information
charlie1329 committed May 20, 2024
1 parent 1937513 commit e868571
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

name: Deploy
# Deploy sphinx documentation to GitHub Pages in docs branch

on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]

jobs:
build:
runs-on: ubuntu-latest
steps:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v2
# install the dependencies
- name: Install dependencies
run: pip install -r docs/requirements.txt
# build the documentation
- name: Build documentation
run: |
cd docs
make html
# upload the documentation to GitHub Pages
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
deploy:
# Add a dependency to the build job
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest

steps:
# deploy the documentation to GitHub Pages
- name: Deploy to github pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit e868571

Please sign in to comment.