# 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](https://jaxlint.readthedocs.io/).

## Contents

| Document | What it covers |
|----------|----------------|
| [CLI reference](cli.md) | Commands, flags, exit codes |
| [Configuration](configuration.md) | **`jaxlint.toml`** (`[jaxlint]` or legacy `[tool.jaxlint]`) and **`pyproject.toml`** (`[tool.jaxlint]`) |
| [Library usage](library.md) | `run_checks`, diagnostics, formatting |
| [Rule catalogue](rules.md) | Rule IDs, severity, fixtures |
| [API reference](api.md) | Generated reference for `jaxlint.core` |
| [HLO extra](hlo.md) | Installing and importing `jaxlint.hlo` |
| [ADR 0001 — HLO diagnostics feasibility](adr/0001-hlo-diagnostics-feasibility.md) | Phase A metrics and kill criteria before **`HLO*`** rules |
| [Language server](lsp.md) | Optional **`jaxlint[lsp]`** diagnostics-only LSP (stdio) |
| [Roadmap](roadmap.md) | Phased product and technical direction |
| [Release runway (notes)](runway.md) | Pre-publish packaging checklist (internal sprint artifact) |
| [Changelog](changelog.md) | Release notes and unreleased doc/test changes |
| [Contributing](contributing.md) | Tests, coverage, CI markers |

Start from the [project README](https://github.com/maraxen/jaxlint/blob/main/README.md) (install and CLI quick start). If the repository URL changes, update links in this page and in `docs/conf.py`.

```{toctree}
:hidden:
:maxdepth: 2
:caption: Guides

cli
configuration
library
api
rules
hlo
adr/0001-hlo-diagnostics-feasibility
lsp
roadmap
runway
changelog
contributing
```