typedoc.config.cjs

'use strict';

/** @type {import('typedoc').TypeDocOptions} */
module.exports = {
  entryPoints: ['./src/main.ts'],
  out: 'docs/dist',
  name: 'Viam SDK',
  customCss: './docs/docs.css',
  cname: 'ts.viam.dev',
  disableSources: true,
  exclude: ['e2e/**/*.spec.ts'],
  // see: https://typedoc.org/options/organization/#kindsortorder
  kindSortOrder: [
    'Function',
    'Project',
    'Module',
    'Enum',
    'EnumMember',
    'Class',
    'Interface',
    'TypeAlias',
    'Constructor',
    'Property',
    'Variable',
    'Accessor',
    'Method',
    'Parameter',
    'TypeParameter',
    'TypeLiteral',
    'CallSignature',
    'ConstructorSignature',
    'IndexSignature',
    'GetSignature',
    'SetSignature',
    'Reference',
    'Namespace',
  ],
  navigationLinks: {
    GitHub: 'https://github.com/viamrobotics/viam-typescript-sdk',
  },
};