mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 13:33:20 +12:00
chore: separate ash doc index from doc index
This commit is contained in:
parent
e7f9bfe88c
commit
cc58d7c9ba
2 changed files with 21 additions and 14 deletions
|
@ -1,19 +1,13 @@
|
|||
defmodule Ash.DocIndex do
|
||||
@moduledoc "A module for configuring how a library is rendered in ash_hq"
|
||||
@type extension :: %{
|
||||
optional(:module) => module,
|
||||
optional(:target) => String.t(),
|
||||
optional(:default_for_target?) => boolean,
|
||||
optional(:name) => String.t(),
|
||||
optional(:type) => String.t()
|
||||
}
|
||||
|
||||
@callback extensions() :: list(extension())
|
||||
|
||||
@behaviour __MODULE__
|
||||
defmodule Ash.DocIndex.AshDocIndex do
|
||||
@moduledoc "Doc index for Ash"
|
||||
@behaviour Ash.DocIndex
|
||||
|
||||
@impl true
|
||||
@spec extensions() :: list(extension)
|
||||
@spec for_library() :: String.t()
|
||||
def for_library, do: "ash"
|
||||
|
||||
@impl true
|
||||
@spec extensions() :: list(Ash.DocIndex.extension())
|
||||
def extensions do
|
||||
[
|
||||
%{
|
13
lib/ash/doc_index/doc_index.ex
Normal file
13
lib/ash/doc_index/doc_index.ex
Normal file
|
@ -0,0 +1,13 @@
|
|||
defmodule Ash.DocIndex do
|
||||
@moduledoc "A module for configuring how a library is rendered in ash_hq"
|
||||
@type extension :: %{
|
||||
optional(:module) => module,
|
||||
optional(:target) => String.t(),
|
||||
optional(:default_for_target?) => boolean,
|
||||
optional(:name) => String.t(),
|
||||
optional(:type) => String.t()
|
||||
}
|
||||
|
||||
@callback extensions() :: list(extension())
|
||||
@callback for_library() :: String.t()
|
||||
end
|
Loading…
Reference in a new issue