Utility.Documentation (Portico/Z v0.1.0)
Functions to simplify documentation across Z / EXPLO.
Check the root-level mix.exs
for functions that run diagramming
when mix docs
is called.
Link to this section Summary
Functions
Embed a schema diagram into the current module docs.
Link to this section Functions
Link to this function
schema_diagram(module)
Embed a schema diagram into the current module docs.
Typically meant to be included in a @moduledoc
like so:
#{Utility.Documentation.schema_diagram(__MODULE__)}
See the Schema Diagrams guide for more information.