class documentation

class GenericAliasDocumenter(DataDocumenter):

View In Hierarchy

Specialized Documenter subclass for GenericAliases.
Method __init__ Undocumented
Class Variable directivetype Undocumented
Class Variable objtype Undocumented
Class Variable priority Undocumented

Inherited from DataDocumenter:

Class Method can​_document​_member Called to see if a member can be documented by this Documenter.
Method add​_content Add content from docstrings, attribute documentation and user.
Method add​_directive​_header Add the directive header and options to the generated content.
Method document​_members Generate reST for member documentation.
Method get​_doc Decode and return lines of the docstring(s) for the object.
Method get​_module​_comment Undocumented
Method get​_real​_modname Get the real module name of an object to document.
Method import​_object Import the object given by self.modname and self.objpath and set it as self.object.
Method should​_suppress​_value​_header Check :value: header should be suppressed.
Method update​_annotations Update __annotations__ to support type_comment and so on.
Class Variable member​_order Undocumented
Class Variable option​_spec Undocumented
Instance Variable analyzer Undocumented

Inherited from GenericAliasMixin (via DataDocumenter):

Method should​_suppress​_directive​_header Check directive header should be suppressed.
Method update​_content Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via DataDocumenter, GenericAliasMixin):

Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented

Inherited from NewTypeMixin (via DataDocumenter):

Method should​_suppress​_directive​_header Check directive header should be suppressed.
Method update​_content Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via DataDocumenter, NewTypeMixin):

Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented

Inherited from TypeVarMixin (via DataDocumenter):

Method should​_suppress​_directive​_header Check directive header should be suppressed.
Method update​_content Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via DataDocumenter, TypeVarMixin):

Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented

Inherited from UninitializedGlobalVariableMixin (via DataDocumenter):

Instance Variable object Undocumented
Instance Variable parent Undocumented

Inherited from DataDocumenterMixinBase (via DataDocumenter, UninitializedGlobalVariableMixin):

Method should​_suppress​_directive​_header Check directive header should be suppressed.
Method update​_content Update docstring for the NewType object.
Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable objpath Undocumented

Inherited from ModuleLevelDocumenter (via DataDocumenter):

Method resolve​_name Resolve the module and name of the object to document given by the arguments and the current module/class.

Inherited from Documenter (via DataDocumenter, ModuleLevelDocumenter):

Method ​_call​_format​_args Undocumented
Method add​_line Append one line of generated reST to the output.
Method check​_module Check if self.object is really defined in the module given by self.modname.
Method filter​_members Filter the given member list.
Method format​_args Format the argument signature of self.object.
Method format​_name Format the name of self.object.
Method format​_signature Format the signature (arguments and return annotation) of the object.
Method generate Generate reST for the object given by self.name, and possibly for its members.
Method get​_attr getattr() override for types such as Zope interfaces.
Method get​_object​_members Return (members_check_module, members) where members is a list of (membername, member) pairs of the members of self.object.
Method get​_sourcename Undocumented
Method parse​_name Determine what module to import and what attribute to document.
Method process​_doc Let the user process the docstrings before adding them.
Method sort​_members Sort the given member list.
Class Variable content​_indent Undocumented
Class Variable titles​_allowed Undocumented
Instance Variable args Undocumented
Instance Variable config Undocumented
Instance Variable directive Undocumented
Instance Variable env Undocumented
Instance Variable fullname Undocumented
Instance Variable indent Undocumented
Instance Variable modname Undocumented
Instance Variable module Undocumented
Instance Variable name Undocumented
Instance Variable object Undocumented
Instance Variable object​_name Undocumented
Instance Variable objpath Undocumented
Instance Variable options Undocumented
Instance Variable parent Undocumented
Instance Variable real​_modname Undocumented
Instance Variable retann Undocumented
Property documenters Returns registered Documenter classes
def __init__(self, *args, **kwargs):

Undocumented

Parameters
*args:AnyUndocumented
**kwargs:AnyUndocumented
directivetype: str =

Undocumented

objtype: str =
priority =