models¶
Enums¶
MethodType¶
Describes the nature of the method.
| MethodType |
|---|
| NORMAL |
| STATIC |
| CLASS |
| PROPERTY |
| DUNDER |
| ABSTRACTPROPERTY |
ClassType¶
Enum for what kind of class it is.
| ClassType |
|---|
| NORMAL |
| DATACLASS |
Classes¶
Signature¶
Signature information
Fields¶
| Name | Type |
|---|---|
| name | str |
| params | typing.List[str] |
| returnval | str |
from_callable¶
@staticmethod
def from_callable(f: Callable, fname: str = None) -> Signature:
Function¶
Holds information for functions, but not methods.
Fields¶
| Name | Type |
|---|---|
| name | str |
| signature | Signature |
| docstring | str |
from_callable¶
@staticmethod
def from_callable(func) -> Function:
Method¶
Contains information about a method, including it's signature and properties.
Fields¶
| Name | Type |
|---|---|
| name | str |
| type | MethodType |
| signature | Signature |
| docstring | str |
from_callable¶
@staticmethod
def from_callable(func, method_type: mkdocs_apidoc.models.MethodType, fname: Union[str, NoneType] = None) -> Method:
Class¶
Contains class information
Fields¶
| Name | Type |
|---|---|
| name | str |
| docstring | str |
| type | ClassType |
| fields | typing.List[mkdocs_apidoc.models.Field] |
| methods | typing.List[mkdocs_apidoc.models.Method] |
from_class¶
@staticmethod
def from_class(cls):
Module¶
Holds module contents
Fields¶
| Name | Type |
|---|---|
| name | str |
| docstring | str |
| functions | typing.List[mkdocs_apidoc.models.Function] |
| classes | typing.List[mkdocs_apidoc.models.Class] |
| enums | typing.List[mkdocs_apidoc.models.Enumeration] |
from_module¶
@staticmethod
def from_module(m) -> Module: