View Source Spark.DocIndex behaviour (spark v0.1.11)
A module for creating an index of documentation for a library. Can be rendered by tools like ash_hq
.
There is a small template syntax available in any documentation. The template syntax will link to the user's currently selected version for the relevant library.
All templates should be wrapped in double curly braces, e.g {{}}
.
links-to-other-documentation
Links to other documentation
{{link:library:item_type:name}}
For example:
{{link:ash:guide:Attributes}}
might be transformed to <a href="/docs/guides/ash/topics/attributes.md">Attributes</a>
mix-dependencies
Mix dependencies
{{mix_dep:library}}
For example:
{{mix_dep:ash}}
might be transformed to {:ash, "~> 1.5"}
Link to this section Summary
Functions
Pulls the hex docs extras from docs in the priv directory
Pulls the hex docs groups_for_extras from docs in the priv directory
Link to this section Types
Link to this section Callbacks
Link to this section Functions
Pulls the hex docs extras from docs in the priv directory
Pulls the hex docs groups_for_extras from docs in the priv directory