View Source Spark.DocIndex behaviour (spark v1.0.4)

A module for creating an index of documentation for a library. Can be rendered by tools like ash_hq.

This has been deprecated, but remains for backwards compatibility

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(),
  :path => String.t(),
  :category => String.t() | nil,
  :route => String.t() | nil,
  optional(:basename) => String.t()
}

Link to this section Callbacks

Link to this callback

code_modules()

View Source (optional)
@callback code_modules() :: [{String.t() | atom(), [module()] | Regex.t()}]
@callback extensions() :: [extension()]
@callback for_library() :: String.t()
@callback guides() :: [guide()]
@callback mix_tasks() :: [{String.t(), [module()]}]

Link to this section Functions

Link to this function

find_undocumented_items(doc_index)

View Source
Link to this function

render_links(docs, callback, context)

View Source
Link to this function

render_replacements(docs, contexts \\ %{}, callback)

View Source

This has been deprecated and will be removed in future releases