docs/packages/python/src/generated.ts

interface ModuleInterface {
  name: string;
  path: string;
  description: string | null;
  docstring: DocstringSection[] | null;
  modules: { [key: string]: ModuleInterface };
  attributes: AttributeInterface[];
  classes: { [key: string]: ClassInterface };
  functions: { [key: string]: FunctionInterface };
  version?: string;
}

interface ClassInterface {
  name: string;
  path: string;
  description: string | null;
  docstring: DocstringSection[] | null;
  parameters: ParameterInterface[];
  attributes: AttributeInterface[];
  functions: { [key: string]: FunctionInterface };
  source: string;
  inherited_members: { [key: string]: { kind: string; path: string }[] };
}

interface FunctionInterface {
  name: string;
  path: string;
  signature: string;
  description: string | null;
  docstring: DocstringSection[];
  parameters: ParameterInterface[];
  returns: ReturnInterface;
  source: string;
}

interface AttributeInterface {
  name: string;
  annotation: string | null;
  description: DocstringSection[] | null;
  value: string | null;
}

type DocstringSection =
  | {
      kind: 'text';
      value: string;
    }
  | {
      kind: 'code';
      value: string;
      title?: string;
    }
  | {
      kind: 'admonition';
      value: {
        annotation: string;
        description: string;
      };
      title: string;
    }
  | {
      kind: 'examples';
      value: [string, string][];
    }
  | {
      kind: string;
      value: any;
      title?: string;
    };

interface ParameterInterface {
  name: string;
  annotation: string | null;
  description: string | DocstringSection[] | null;
  value?: string | null;
}

interface ReturnInterface {
  name: string;
  annotation: string | null;
  description: string | null;
}

export type {
  ModuleInterface,
  ClassInterface,
  FunctionInterface,
  AttributeInterface,
  DocstringSection,
  ParameterInterface,
  ReturnInterface,
};