c743416ded
Mirror the auto-indexed per-host pattern for a new docs/services/ category, seeded with the six things currently deployed on or around makerfloss.eu: docs, slides, forgejo, gandi-dns, marp, mermaid. Generator/hook generalisation: - scripts/gen_overview.py: replace the hardcoded `hostname` check with a configurable `key_field` (default: hostname). Add a generic `key-link` column kind (replaces the old `hostname-link`) and a `url-link` kind that renders the value as a clickable link. - scripts/overview_config.yml: declare hardware's key_field, then add a `services` block (key_field=name, its own kind/status enums, grouped by kind for the index table). - scripts/mkdocs_hooks.py: route by `page.file.src_uri` so each hardware/* page gets a "Specs" table and each services/* page gets a "Service" table; both share the helpers in gen_overview. Wiring: - Makefile: docs-index and docs-check now regenerate and drift-check both indices. - .forgejo/workflows/docs.yml: same on the CI runner. - mkdocs.yml: add Services to nav. - README.md, CLAUDE.md: list services/ in the repo-layout block. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
48 lines
1.4 KiB
YAML
48 lines
1.4 KiB
YAML
name: Build docs site
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: self-hosted
|
|
container:
|
|
image: python:3.13-bookworm
|
|
volumes:
|
|
- /srv/docs-makerfloss/html:/output
|
|
steps:
|
|
- name: Install git, rsync, nodejs for actions/checkout
|
|
run: |
|
|
apt-get update -qq
|
|
apt-get install -y --no-install-recommends git rsync nodejs
|
|
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Install Python dependencies
|
|
run: pip install --quiet -r requirements.txt
|
|
|
|
- name: Regenerate hardware and services indices
|
|
run: |
|
|
python3 scripts/gen_overview.py --category hardware
|
|
python3 scripts/gen_overview.py --category services
|
|
|
|
- name: Fail on drift in generated indices
|
|
run: |
|
|
if ! git diff --exit-code docs/hardware/index.md docs/services/index.md; then
|
|
echo
|
|
echo "::error::A generated index is stale."
|
|
echo "Regenerate locally via 'make docs-index' and commit the result."
|
|
exit 1
|
|
fi
|
|
|
|
- name: Build site (strict)
|
|
run: mkdocs build --strict
|
|
|
|
- name: Publish to /output (main only)
|
|
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
|
|
run: rsync -a --delete site/ /output/
|