Skip to content

docs: add ReadTheDocs MkDocs scaffold #4

docs: add ReadTheDocs MkDocs scaffold

docs: add ReadTheDocs MkDocs scaffold #4

Workflow file for this run

name: Docs Build
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
jobs:
mkdocs:
name: MkDocs Strict Build
runs-on: ubuntu-22.04
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install documentation dependencies
run: python -m pip install -r docs/requirements.txt
- name: Build documentation
run: python -m mkdocs build --strict --config-file mkdocs.yml