View Source Ash.DocIndex behaviour (ash v1.52.0-rc.3)

A module for configuring how a library is rendered in ash_hq

Link to this section Summary

Link to this section Types

@type extension() :: %{
  optional(:module) => module(),
  optional(:target) => String.t(),
  optional(:default_for_target?) => boolean(),
  name: String.t(),
  type: String.t()
}
@type guide() :: %{
  name: String.t(),
  text: String.t(),
  category: String.t() | nil,
  route: String.t() | nil
}

Link to this section Callbacks

@callback code_modules() :: [module()]
@callback extensions() :: [extension()]
@callback for_library() :: String.t()
@callback guides() :: [guide()]

Link to this section Functions