mix nbpr.catalogue (NBPR v0.2.1)

Copy Markdown View Source

Refreshes docs/reference/catalogue.md by globbing the workspace's packages/nbpr_*/ directories and reading each package's mix.exs for the version and description.

No network access — the workspace itself is the source of truth. Retired or legacy packages aren't in the workspace, so they're naturally excluded.

mix nbpr.catalogue [--root <path>] [--output <path>]

Wired up via the docs: alias in nbpr/mix.exs, so mix docs always generates a fresh catalogue before ExDoc renders.

Flags

  • --root <path> — workspace root (defaults to the parent of the current directory, i.e. correct when invoked from nbpr/).
  • --output <path> — where to write the catalogue (defaults to <root>/docs/reference/catalogue.md).

Summary

Functions

catalogue_markdown(pkgs)

Renders the catalogue markdown for pkgs. Public for testability.

Functions

catalogue_markdown(pkgs)

@spec catalogue_markdown([
  %{name: String.t(), version: String.t(), description: String.t()}
]) ::
  String.t()

Renders the catalogue markdown for pkgs. Public for testability.

Each entry in pkgs is a %{name, version, description} map.