sphinx_expose_init_alias.documenter

class sphinx_expose_init_alias.documenter.AliasClassDocumenter(directive: DocumenterBridge, name: str, indent: str = '')

Parameters:

• directive (DocumenterBridge) –

• name (str) –

• indent (str) –

classmethod can_document_member(member: Any, membername: str, isattr: bool, parent: Any) → bool

Called to see if a member can be documented by this Documenter.

Parameters:

• member (Any) –

• membername (str) –

• isattr (bool) –

• parent (Any) –

Return type:

bool

objtype = 'aliasclass'

name by which the directive is called (auto…) and the default generated directive name

priority = 100000001

priority if multiple documenters return True from can_document_member

class sphinx_expose_init_alias.documenter.AliasDocumenter(directive: DocumenterBridge, name: str, indent: str = '')

Parameters:

• directive (DocumenterBridge) –

• name (str) –

• indent (str) –

add_content(more_content: Optional[StringList]) → None

Add content from docstrings, attribute documentation and user.

Parameters:

more_content (Optional[StringList]) –

Return type:

None

classmethod can_document_member(member: Any, membername: str, isattr: bool, parent: Any) → bool

Called to see if a member can be documented by this Documenter.

Parameters:

• member (Any) –

• membername (str) –

• isattr (bool) –

• parent (Any) –

Return type:

bool

format_signature(**kwargs: Any) → str

Format the signature (arguments and return annotation) of the object.

Let the user process it via the autodoc-process-signature event.

Parameters:

kwargs (Any) –

Return type:

str

get_object_members(want_all: bool) → Tuple[bool, Union[List[ObjectMember], List[Tuple[str, Any]]]]

Return (members_check_module, members) where members is a list of (membername, member) pairs of the members of self.object.

If want_all is True, return all members. Else, only return those members given by self.options.members (which may also be None).

Parameters:

want_all (bool) –

Return type:

Tuple[bool, Union[List[ObjectMember], List[Tuple[str, Any]]]]

objtype = 'alias'

name by which the directive is called (auto…) and the default generated directive name

priority = 100000000

priority if multiple documenters return True from can_document_member

class sphinx_expose_init_alias.documenter.AliasExceptionDocumenter(directive: DocumenterBridge, name: str, indent: str = '')

Parameters:

• directive (DocumenterBridge) –

• name (str) –

• indent (str) –

classmethod can_document_member(member: Any, membername: str, isattr: bool, parent: Any) → bool

Called to see if a member can be documented by this Documenter.

Parameters:

• member (Any) –

• membername (str) –

• isattr (bool) –

• parent (Any) –

Return type:

bool

objtype = 'aliasexception'

name by which the directive is called (auto…) and the default generated directive name

priority = 100000010

priority if multiple documenters return True from can_document_member

class sphinx_expose_init_alias.documenter.AliasFunctionDocumenter(directive: DocumenterBridge, name: str, indent: str = '')

Parameters:

• directive (DocumenterBridge) –

• name (str) –

• indent (str) –

classmethod can_document_member(member: Any, membername: str, isattr: bool, parent: Any) → bool

Called to see if a member can be documented by this Documenter.

Parameters:

• member (Any) –

• membername (str) –

• isattr (bool) –

• parent (Any) –

Return type:

bool

objtype = 'aliasfunction'

name by which the directive is called (auto…) and the default generated directive name

priority = 100000002

priority if multiple documenters return True from can_document_member

class sphinx_expose_init_alias.documenter.AliasModuleDocumenter(*args: Any)

Parameters:

args (Any) –

get_object_members(want_all: bool) → Tuple[bool, Union[List[ObjectMember], List[Tuple[str, Any]]]]

Return (members_check_module, members) where members is a list of (membername, member) pairs of the members of self.object.

If want_all is True, return all members. Else, only return those members given by self.options.members (which may also be None).

Parameters:

want_all (bool) –

Return type:

Tuple[bool, Union[List[ObjectMember], List[Tuple[str, Any]]]]

import_object(raiseerror: bool = False) → bool

Import the object given by self.modname and self.objpath and set it as self.object.

Returns True if successful, False if an error occurred.

Parameters:

raiseerror (bool) –

Return type:

bool

objtype = 'aliasmodule'

name by which the directive is called (auto…) and the default generated directive name

priority = 10

priority if multiple documenters return True from can_document_member