# `SnakeBridge.Docs.SphinxInventory`
[🔗](https://github.com/nshkrdotcom/snakebridge/blob/v0.16.0/lib/snakebridge/docs/sphinx_inventory.ex#L1)

Parser for Sphinx `objects.inv` inventories (version 2).

This is used to derive a *documented* API surface from published docs without
requiring access to the Sphinx source tree.

# `entry`

```elixir
@type entry() :: %{
  name: String.t(),
  domain_role: String.t(),
  priority: non_neg_integer(),
  uri: String.t(),
  dispname: String.t()
}
```

# `t`

```elixir
@type t() :: %{
  project: String.t() | nil,
  version: String.t() | nil,
  entries: [entry()]
}
```

# `parse`

```elixir
@spec parse(binary()) :: {:ok, t()} | {:error, term()}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*