Skip to content

feature/random-functions #1677

feature/random-functions

feature/random-functions #1677

Workflow file for this run

---
name: 'Deploy Docs'
on:
workflow_dispatch:
push:
tags:
- 'latest'
branches:
- 'main'
pull_request:
branches:
- 'main'
concurrency:
group: "${{ github.workflow }}-${{ github.ref }}"
cancel-in-progress: false
permissions: read-all
jobs:
build_docs:
name: 'Build Docs'
runs-on: intellabs-01
container:
image: ghcr.io/sphinx-doc/sphinx:7.1.2
volumes:
- ${{ github.workspace }}:/ws
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1
- name: Build
shell: bash
run: |
apt update
apt install -y -qq --no-install-recommends enchant-2
pip install -r docs/requirements.txt
sphinx-build -W -b linkcheck ./docs _build
sphinx-build -W -b spelling ./docs _build
sphinx-build -M html ./docs _build
- name: Upload artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa #v3.0.1
with:
path: '_build/html'
deploy_publish_github_pages:
name: 'Deploy to GitHub Pages'
needs: build_docs
if: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main' }}
runs-on: intellabs-01
container:
image: ghcr.io/sphinx-doc/sphinx:7.1.2
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- name: Setup Pages
uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@decdde0ac072f6dcbe43649d82d9c635fff5b4e4 # v4.0.4