Skip to content

docs: add demo in README #44

docs: add demo in README

docs: add demo in README #44

Workflow file for this run

name: Docs - Validate
on:
workflow_dispatch: {}
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
- cron: '16 5 * * *' # Every day at 05:16 UTC
permissions: {}
jobs:
build:
name: Build
runs-on: ubuntu-24.04
timeout-minutes: 5
permissions:
contents: read
steps:
# Firewall rules:
# -> "*.github.com": Standard interactions with GitHub
# -> "*.pypi.org" & "files.pythonhosted.org": Downloading Python packages
- name: Harden runner
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
with:
disable-sudo: true
egress-policy: block
allowed-endpoints: >
github.com:443
pypi.org:443
files.pythonhosted.org:443
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
persist-credentials: false
- name: Setup Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: 3.13
- name: Install MkDocs Material
run: pip install --require-hashes --requirement docs/user-guide/requirements.txt
- name: Copy License
run: cp LICENSE.md docs/user-guide/src/license.md
- name: Build Site
working-directory: docs/user-guide/
run: mkdocs build --strict