Record

Config

Module PuduLangDocgen.Configuration

type Config = {
  metadata: Array[ApiSource],
  content: Array[Mapping],
  resource: Array[Mapping],
  overwrite: Array[Mapping],
  output: Str,
  globalMetadata: Array[(Str, Docgen.Meta)],
  globalMetadataFiles: Array[Str],
  fileMetadata: Array[Meta.Rule],
  fileMetadataFiles: Array[Str],
  templates: Array[Str],
  xref: Array[Str],
  sitemap: Option[Sitemap.Options],
  gitFeatures: Bool,
  contribution: Contribution,
  warningsAsErrors: Bool,
  rules: Array[(Str, Str)],
  alerts: Array[(Str, Str)],
  diagrams: Diagrams,
  dryRun: Bool,
  exportRawModel: Str,
  exportViewModel: Str,
  pdf: Option[Pdf]
}

View source

Everything a build reads from the project configuration

Fields

Name Type Description
metadata Array[ApiSource]
content Array[Mapping]
resource Array[Mapping]
overwrite Array[Mapping]
output Str
globalMetadata Array[(Str, Docgen.Meta)]
globalMetadataFiles Array[Str]
fileMetadata Array[Meta.Rule]
fileMetadataFiles Array[Str]
templates Array[Str]
xref Array[Str]
sitemap Option[Sitemap.Options]
gitFeatures Bool
contribution Contribution
warningsAsErrors Bool
rules Array[(Str, Str)]
alerts Array[(Str, Str)]
diagrams Diagrams
dryRun Bool
exportRawModel Str
exportViewModel Str
pdf Option[Pdf]
Name Description
defaults Settings used when a configuration names nothing else.
parse A configuration read from JSON or YAML text; the file name decides the format and appears in every diagnostic.