View Source mix zig_doc (zig_doc v0.4.0)

Runs mix docs, except with Zig.Doc.generate_docs/3 as the callback.

This injects a processing step for zig documentation at the end of the mix doc step, including specified zig files as "modules" in the ExDoc system. These files are incorporated under the ZIG CODE module category.

This is most effectively used by aliasing it in your mix.exs:

def project do
  [
    ...
    aliases: [
      docs: ["zig_doc"]
    ]
    ...
  ]
end

see Mix.Tasks.Docs for more information

Summary

Functions

run(params, zig_doc_options \\ [])

Functions

run(params, zig_doc_options \\ [])

@spec run(
  [String.t()],
  keyword()
) :: :ok