sphinx.ext.autodoc.UninitializedGlobalVariableMixin

class documentation

class UninitializedGlobalVariableMixin(DataDocumenterMixinBase): (source)

Known subclasses: sphinx.ext.autodoc.DataDocumenter

View In Hierarchy

Mixin for DataDocumenter to provide the feature for supporting uninitialized (type annotation only) global variables.

Method get_doc Undocumented
Method import_object Undocumented
Method should_suppress_value_header Check :value: header should be suppressed.

Inherited from DataDocumenterMixinBase:

Method should_suppress_directive_header Check directive header should be suppressed.
Method update_content Update docstring, for example with TypeVar variance.
Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented
def get_doc(self): (source)
overridden in sphinx.ext.autodoc.DataDocumenter

Undocumented

Returns
list[list[str]]|NoneUndocumented
def import_object(self, raiseerror=False): (source)
overridden in sphinx.ext.autodoc.DataDocumenter

Undocumented

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def should_suppress_value_header(self): (source)
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_value_header
overridden in sphinx.ext.autodoc.DataDocumenter

Check :value: header should be suppressed.

Returns
boolUndocumented