Skip to content

docs: use the richer architecture diagram for the system overview #3

docs: use the richer architecture diagram for the system overview

docs: use the richer architecture diagram for the system overview #3

Workflow file for this run

name: Deploy docs
on:
workflow_dispatch:
push:
branches: [main]
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/docs.yml'
pull_request:
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/docs.yml'
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install docs dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -r docs/requirements-docs.txt
- name: Build docs
run: python -m mkdocs build
- name: Deploy to GitHub Pages
if: github.event_name != 'pull_request'
run: python -m mkdocs gh-deploy --force --clean