jaxlint documentation

jaxlint documentation#

jaxlint is a CLI and Python library for JAX-oriented static checks (AST “sensors”), docstring structure, MathJax/LaTeX hygiene, and optional StableHLO-oriented helpers.

  • jaxlint.core does not import JAX. Use it from build tools, pre-commit, or your own runners.

  • jaxlint[hlo] adds jaxlint.hlo (requires JAX). Use it when you need export/HLO-level analysis.

Hosted documentation#

HTML, PDF, and htmlzip builds are published via Read the Docs.

Contents#

Document

What it covers

CLI reference

Commands, flags, exit codes

Configuration

jaxlint.toml ([jaxlint] or legacy [tool.jaxlint]) and pyproject.toml ([tool.jaxlint])

Library usage

run_checks, diagnostics, formatting

Rule catalogue

Rule IDs, severity, fixtures

API reference

Generated reference for jaxlint.core

HLO extra

Installing and importing jaxlint.hlo

ADR 0001 — HLO diagnostics feasibility

Phase A metrics and kill criteria before HLO* rules

Language server

Optional jaxlint[lsp] diagnostics-only LSP (stdio)

Roadmap

Phased product and technical direction

Release runway (notes)

Pre-publish packaging checklist (internal sprint artifact)

Changelog

Release notes and unreleased doc/test changes

Contributing

Tests, coverage, CI markers

Start from the project README (install and CLI quick start). If the repository URL changes, update links in this page and in docs/conf.py.

Contents