docs: add spark doc index (#43)

This commit is contained in:
Zach Daniel 2023-01-09 15:56:11 -05:00 committed by GitHub
parent c244ac4ef9
commit cc55a47ab7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 53 additions and 0 deletions

View file

@ -1,3 +1,6 @@
import Config import Config
# Necessary to remove warning from core when developing/testing
config :ash, :use_all_identities_in_manage_relationship?, false
import_config "#{config_env()}.exs" import_config "#{config_env()}.exs"

View file

@ -0,0 +1,50 @@
defmodule AshAuthentication.Phoenix.SparkDocIndex do
@moduledoc false
use Spark.DocIndex, otp_app: :ash_authentication_phoenix, guides_from: ["documentation/**/*.md"]
@doc false
@impl true
@spec for_library :: String.t()
def for_library, do: "ash_authentication_phoenix"
@doc false
@impl true
@spec extensions :: [Spark.DocIndex.extension()]
def extensions do
[]
end
@doc false
@impl true
@spec mix_tasks :: [{String.t(), [module]}]
def mix_tasks, do: []
@doc false
@impl true
def code_modules do
[
Welcome: [
AshAuthentication.Phoenix
],
"Routing and Controller": [
AshAuthentication.Phoenix.Controller,
AshAuthentication.Phoenix.Plug,
AshAuthentication.Phoenix.Router
],
Customisation: [
AshAuthentication.Phoenix.Overrides,
AshAuthentication.Phoenix.Overrides.Default
],
Components: [
AshAuthentication.Phoenix.SignInLive,
AshAuthentication.Phoenix.Components.SignIn,
AshAuthentication.Phoenix.Components.OAuth2,
AshAuthentication.Phoenix.Components.Password,
AshAuthentication.Phoenix.Components.Password.SignInForm,
AshAuthentication.Phoenix.Components.Password.RegisterForm,
AshAuthentication.Phoenix.Components.Password.Input
]
]
end
end