Auto

Auto(**kwargs)

Configure a python object to document (e.g. module, class, function, attribute).

Attributes

name : str: Name of the object. This should be the path needed to import it.
signature_name : SignatureOptions: Style of name to use in the signature. Can be “relative”, “full”, or “short”. Relative is whatever was used as the name argument, full is the fully qualified path the object, and short is the name of the object (i.e. no periods).
members : Optional[list[str]]: A list of members, such as attributes or methods on a class, to document. If members is specified, no other includes or excludes are applied.
include_private : bool: Whether to include members starting with “_”
include_imports : bool: Whether to include members that were imported from somewhere else.
include_empty : bool: Whether to include members with no docstring.
include_inherited : bool: Whether to include members inherited from a parent class.
include_attributes : bool: Whether to include attributes.
include_classes : bool: Whether to include classes.
include_functions : bool: Whether to include functions.
include : Optional[str]: (Not implemented). A list of members to include.
exclude : Optional[list[str]]: A list of members to exclude. This is performed last, in order to subtract from the results of options like include_functions.
dynamic : Union[None, bool, str]: Whether to dynamically load docstring. By default docstrings are loaded using static analysis. dynamic may be a string pointing to another object, to return an alias for that object.
children : ChoicesChildren: Style for presenting members. Either separate, embedded, or flat.
package : Union[str, None, MISSING]: If specified, object lookup will be relative to this path.
member_order : Literal['alphabetical', 'source']: Order to present members in, either “alphabetical” or “source” order. Defaults to alphabetical sorting.
member_options : Optional['AutoOptions']: Options to apply to members. These can include any of the options above.