Skip to content

structural-explainability/site

Repository files navigation

Site: Structural Explainability

License: Apache-2.0 Deploy Docs Build Status Check Links Dependabot

Documentation site for Structural Explainability.

This repository hosts the public-facing site built with MkDocs and deployed via GitHub Pages. It is docs-only and does not produce a Python package.

Developer

Steps to run pre-commit locally. Install uv.

Initialize once:

uv self update
uv python pin 3.12
uv sync --extra dev --extra docs --upgrade

uvx pre-commit install
git add -A
uvx pre-commit run --all-files

Build and serve docs:

uv run mkdocs build --strict
uv run mkdocs serve

Save progress as needed:

git add -A
# If pre-commit makes changes, re-run `git add -A` before committing.
git commit -m "update"
git push -u origin main

Annotations

Annotations.md

License

MIT

Releases

No releases published