Record

Options

type Options = {
  output: Str,
  metadata: Array[(Str, Docgen.Meta)],
  xref: Array[Str],
  templates: Array[Str],
  warningsAsErrors: Bool,
  dryRun: Bool,
  disableGitFeatures: Bool,
  force: Bool,
  exportRawModel: Bool,
  exportViewModel: Bool
}

View source

Command-line choices layered over the configuration

Fields

Name	Type	Description
`output`	`Str`
`metadata`	`Array[(Str, Docgen.Meta)]`
`xref`	`Array[Str]`
`templates`	`Array[Str]`
`warningsAsErrors`	`Bool`
`dryRun`	`Bool`
`disableGitFeatures`	`Bool`
`force`	`Bool`
`exportRawModel`	`Bool`
`exportViewModel`	`Bool`

Name	Description
`options`	Options that leave the configuration as written.
`load`	A project read from its configuration file with options applied.
`build`	A project built and, unless the run is dry, published incrementally.
`buildAll`	The site built and published, then a PDF for every table of contents that sets `pdf`. Unlike `pdf`, a missing renderer is a warning here, so sites build on machines without a browser.
`pdf`	The site built and published, then a PDF for every table of contents that sets `pdf`.
`metadata`	API metadata written as files beside the configuration, in each source's format.