Record

Input

Module PuduLangDocgen.Build

type Input = {
  config: Configuration.Config,
  paths: Array[Str],
  files: Map[Str, Str],
  resources: Array[(Str, Docgen.Resource)],
  units: Array[Array[Model.Unit]],
  external: Array[Docgen.Reference],
  template: Array[(Str, Str)],
  assets: Array[Docgen.Resource],
  history: Map[Str, Str],
  repository: Configuration.Contribution,
  diagrams: Map[Str, Str],
  generator: Str,
  today: Str
}

View source

Everything a build reads, already loaded from the project

Fields

Name Type Description
config Configuration.Config
paths Array[Str]
files Map[Str, Str]
resources Array[(Str, Docgen.Resource)]
units Array[Array[Model.Unit]]
external Array[Docgen.Reference]
template Array[(Str, Str)]
assets Array[Docgen.Resource]
history Map[Str, Str]
repository Configuration.Contribution
diagrams Map[Str, Str]
generator Str
today Str
Name Description
plan The site plan, or every error found. Warnings travel with a successful plan; nothing is planned for output unless the whole site validates.
site The site plan with its pages and resolved tables of contents, for work that continues from a built site such as printable documents.