render_obj

FunctionSource

v_1: RendererPage | None = render_obj(obj: Any)

Render an arbitrary object as a documentation page.

Arguments

Name Type Required Description

Name	Type	Required	Description
`obj`	`Any`		The object to be rendered, it can be a class, function, or a module. If this argument is a method, the method will be interpreted as a function.

obj

Any

The object to be rendered, it can be a class, function, or a module.

If this argument is a method, the method will be interpreted as a function.

Name	Type	Description
`v_1`	`RendererPage \| None`	The rendered page object. Will be `None` if the given obj cannot be rendered as a documentation page.