ModuleDoc

A component that creates a ModuleDoc block for module-level documentation.

jsx

import { ModuleDoc } from "@alloy-js/python";

<ModuleDoc
  attributes={GoogleStyleDocAttributeProps[]}
  deprecated="string"
  description={Children[]}
  examples={Children[]}
  seeAlso={string[]}
  style={"google"}
  todo={string[]}
  warning="string"
 />

stc

import { ModuleDoc } from "@alloy-js/python/stc";

ModuleDoc({
  attributes: GoogleStyleDocAttributeProps[],
  deprecated: string,
  description: Children[],
  examples: Children[],
  seeAlso: string[],
  style: "google",
  todo: string[],
  warning: string,
}).children(children)

Props

attributes	optionalGoogleStyleDocAttributeProps[]
deprecated	optionalstring
description	Children[]
examples	optionalChildren[]
seeAlso	optionalstring[]
style	optional”google”
todo	optionalstring[]
warning	optionalstring