typedoc.json

{
  "$schema": "https://typedoc.org/schema.json",
  "name": "Legend Studio API Documentation",
  "gitRemote": "origin",
  "gitRevision": "master",
  "hideGenerator": true,
  "includeVersion": true,
  "out": "build/docs",
  "entryPoints": ["."],
  "entryPointStrategy": "packages",
  "exclude": [
    // NOTE: this uses `minimatch` pattern
    "**/fixtures/**",
    "**/scripts/**",
    "**/packages/babel-preset",
    "**/packages/eslint-plugin",
    "**/packages/stylelint-config",
    "**/packages/legend-dev-utils",
    "**/packages/legend-manual-tests", // to be removed post https://github.com/finos/legend-studio/issues/820
    "**/packages/legend-art",
    "**/packages/legend-lego",
    "**/packages/legend-application-*",
    "**/packages/legend-extension-*",
    "**/packages/legend-server-showcase",
    "**/packages/legend-server-showcase-*",
  ],
  // NOTE: to be updated when we structure the doc better
  "readme": "./website/api.md",
  "plugin": ["./website/custom-typedoc-theme.js"],
  "theme": "legend",
  "customCss": "./website/legend-typedoc-theme.css",
  "logLevel": "Verbose",
  "treatWarningsAsErrors": false // TODO: we should enable this once we want to properly enforce the doc generation
}