Skip to content

Expand docs with architecture overview #1

Expand docs with architecture overview

Expand docs with architecture overview #1

Workflow file for this run

name: Check Documentation Build
on:
pull_request:
paths:
- 'docs/**'
- 'aion/**'
- '.github/workflows/docs-check.yml'
- 'pyproject.toml'
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .
pip install -r docs/requirements.txt
- name: Build documentation
run: |
cd docs
sphinx-build -W -b html . _build/html
- name: Check for broken links
run: |
cd docs
sphinx-build -b linkcheck . _build/linkcheck || true