sphinx.ext.autodoc.UninitializedGlobalVariableMixin

class documentation

class UninitializedGlobalVariableMixin(DataDocumenterMixinBase):

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.
Instance Variable object Undocumented
Instance Variable parent Undocumented

Inherited from DataDocumenterMixinBase:

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
def get_doc(self, ignore=None):
overridden in sphinx.ext.autodoc.DataDocumenter

Undocumented

Parameters
ignore:intUndocumented
Returns
Optional[List[List[str]]]Undocumented
def import_object(self, raiseerror=False):
overridden in sphinx.ext.autodoc.DataDocumenter

Undocumented

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def should_suppress_value_header(self):
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_value_header
overridden in sphinx.ext.autodoc.DataDocumenter
Check :value: header should be suppressed.
Returns
boolUndocumented
object =
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.object

Undocumented

parent =
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.parent

Undocumented