Skip to content

Sphinx-docs

Sphinx-docs #24

Workflow file for this run

name: Sphinx-docs
on:
push:
branches:
- main
- documentation-staging
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment, cancel in-progress runs for the same ref.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Pandoc
uses: pandoc/actions/setup@v1
with:
version: 3.5
- name: Install dependencies
run: pip install -r docs/requirements.txt
- name: Build HTML
run: python -m sphinx.cmd.build -M html docs/source docs/build
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4