autodoc_skip_member_handler

Handler for autodoc-skip-member event.

def autodoc_skip_member_handler(
    app: Sphinx,
    what: string,
    name: string,
    obj: object,
    skip: boolean,
    options: object
) - > boolean|null

Handler for autodoc-skip-member event.

Parameters

Name	Type	Description
app	Sphinx	The Sphinx application object instance.
what	string	The type of the object which the docstring belongs to (e.g., 'class', 'method').
name	string	The fully qualified name of the object.
obj	object	The object itself, checked to see if it is a Celery BaseTask with a wrapped function.
skip	boolean	A boolean indicating if autodoc would skip this member by default.
options	object	The options given to the directive.

Returns

Type	Description
`boolean	null`