---
numbering:
  title: true
---

# `arch.idx`: Document Index and Header API

```{py:currentmodule} arch.idx
```

The public package separates styled, arbitrary-depth document indexes from the fixed architectonic address exported as `arch.Quad` (with `arch.Idx` retained for compatibility).

## `1` Domain model

```{eval-rst}
.. automodule:: arch.idx.model
   :members:
   :show-inheritance:
```

## `2` Configuration

```{eval-rst}
.. automodule:: arch.idx.config
   :members:
   :show-inheritance:
```

## `3` Planning and application

```{eval-rst}
.. automodule:: arch.idx.engine
   :members:
   :show-inheritance:
```

## `4` Header model

```{eval-rst}
.. automodule:: arch.idx.headers
   :members:
   :show-inheritance:
```

## `5` Header formatting planner

```{eval-rst}
.. automodule:: arch.idx.header_engine
   :members:
   :show-inheritance:
```

## `6` Keyboard profile editor

```{eval-rst}
.. automodule:: arch.idx.spec_tui
   :members:
   :show-inheritance:
```