Spark.Docs (spark v2.7.1)

Copy Markdown View Source

Tools for generating docs & search data for extras.

Summary

Functions

Builds a redirects map for a DSL from mod/funs to their respective DSL docs.

Generates searchable documentation suitable for ex_doc

Functions

redirects_for(dsls, existing_redirects \\ %{})

Builds a redirects map for a DSL from mod/funs to their respective DSL docs.

This is useful for redirecting links to private DSL modules (like Ash.Resource.Dsl.Actions.Create) to their corresponding documentation pages (like dsl-ash-resource#actions-create).

Example

redirects_for([Ash.Resource.Dsl])
# => %{
#   "Ash.Resource.Dsl.Actions.Create" => "dsl-ash-resource#actions-create",
#   ...
# }

These redirects can be passed to ex_doc's :redirects option to handle links to private DSL modules.

search_data_for(dsl)

Generates searchable documentation suitable for ex_doc