Skip to content

Build and deploy Sphinx docs #8

Build and deploy Sphinx docs

Build and deploy Sphinx docs #8

Workflow file for this run

name: Deploy and build Sphinx docs
on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]
pull_request:
branches: ["master"]
# 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
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build HTML
uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: github-pages
path: docs/_build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
#- name: Checkout
# uses: actions/checkout@v4
#- name: Setup Pages
# uses: actions/configure-pages@v5
#- name: Upload artifact
# uses: actions/upload-pages-artifact@v3
# with:
# path: docs/build/html
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4