[docs] Set up github pages workflow

First pass at a GitHub Actions workflow to deploy the docs site.
This commit is contained in:
Justin C. Miller
2024-03-07 21:59:06 -08:00
parent 396fc131e0
commit d8a21608c3
3 changed files with 61 additions and 1 deletions

56
.github/workflows/sphinx_deploy.yml vendored Normal file
View File

@@ -0,0 +1,56 @@
name: Deploy docs site with Sphinx
on:
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
# Default to bash
defaults:
run:
shell: bash
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Sphinx build
uses: jsix-os/sphinx-action@master
with:
docs-folder: "docs/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
# Deployment job
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/deploy-pages@v4