SnakeBridge.Docs.SphinxInventory (SnakeBridge v0.16.0)

Copy Markdown View Source

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.

Summary

Types

entry()
t()

Functions

parse(content)

Types

entry()

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

t()

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

Functions

parse(content)

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