Function | document |
Generate documentation for an object. This also part of the public API of class |
Function | index |
Generate an HTML index for a directory of modules. |
Function | page |
Format an HTML page. |
Function | render |
Compose two functions |
Generate documentation for an object. This also part of the public API of class
Types of : Module, class, routine, data descriptor, "other" are supported
Modules ignore 1st name.
Public API doesn't call with *args Args are: name, fdict, cdict (name twice?) mod, funcs, classes, mdict, the_object
Parameters | |
the_object:TypeLike | Undocumented |
name:str | Undocumented |
args:Any | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
directory:str | Undocumented |
shadowed:Optional[ | Undocumented |
Returns | |
str | Undocumented |