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	optional GoogleStyleDocAttributeProps[]
deprecated	optional string
description	Children[]
examples	optional Children[]
seeAlso	optional string[]
style	optional “google”
todo	optional string[]
warning	optional string