Skip to content

Deploy sphinx content to Pages #1

Deploy sphinx content to Pages

Deploy sphinx content to Pages #1

# Simple workflow for deploying sphinx to GitHub Pages
name: Deploy sphinx content to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# The workflow will only run when there are changes in the 'docs' or 'OpenGSQ' folders
paths:
- 'docs/**'
- 'opengsq/**'
# 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:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- run: sphinx-apidoc -o docs opengsq
- name: Deploy to GitHub Pages
id: deployment
uses: sphinx-notes/pages@v3