Skip to content

Commit

Permalink
chore: Add GitHub workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
luator committed Dec 14, 2023
1 parent a4a1033 commit 74d59a0
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Build docs using Sphinx and deploy to GitHub Pages.
name: Build
on:
push:
branches:
- master
workflow_dispatch:
inputs:
publish:
description: "Publish to GitHub Pages (disable to only test the build)"
type: boolean
default: false

jobs:
build_and_deploy:
runs-on: ubuntu-latest

# 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 }}

steps:
- name: Build and Deploy Documentation
uses: sphinx-notes/pages@v3
with:
documentation_path: "."
requirements_path: "./requirements.txt"
publish: ${{ github.event_name == 'push' || github.event.inputs.publish == 'true' }}

0 comments on commit 74d59a0

Please sign in to comment.