The "python" generic API models the Python language elements.
Structure of the API
The structure of the API is the following:
Only "module" parent elements can be at the root of each API
A "module" parent element can have "method" or "field" children. Note that a "var" parent element is a "field"
Note that the elements described here are the parent type of the element. See Generic apidocs API types for the list of parent element for each API element.
List of managed types
The following table presents the list of parent types which are managed by the Python generic API.
Parent Type
Top Element
Comment
class
Yes
Represents a module
method
No
Represents a method
argument
argument
Represents an argument
See also
Generic API types: This article explains which elements are managed by each generic API type
apidoc: This article explains how the apidoc element can be used