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

A module for configuring how a library is rendered in ash_hq

Link to this section Summary

Link to this section Types

Specs

extension() :: %{
  optional(:module) => module(),
  optional(:target) => String.t(),
  optional(:default_for_target?) => boolean(),
  name: String.t(),
  type: String.t()
}

Specs

guide() :: %{
  name: String.t(),
  text: String.t(),
  category: String.t() | nil,
  route: String.t() | nil
}

Link to this section Functions

Link to this section Callbacks

Specs

code_modules() :: [module()]

Specs

extensions() :: [extension()]

Specs

for_library() :: String.t()

Specs

guides() :: [guide()]