def add_directive_header(self, sig: str) -> None:
sourcename = self.get_sourcename()
if self.doc_as_attr:
self.directivetype = "attribute"
Documenter.add_directive_header(self, sig)
if self.analyzer and '.'.join(self.objpath) in self.analyzer.finals:
self.add_line(" :final:", sourcename)
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
sourcename = self.get_sourcename()
self.add_line('', sourcename)
if hasattr(self.object, "__bases__") and len(
self.object.__bases__):
bases = []
for b in self.object.__bases__:
if b is TemporaryDirectory:
bases.append(":py:obj:`~tempfile.TemporaryDirectory`")
elif b.__module__ in ("__builtin__", "builtins"):
bases.append(f':class:`{b.__name__}`')
else:
bases.append(format_annotation(b))
self.add_line(" " + _("Bases: %s") % ", ".join(bases),
sourcename)
def my_add_directive_header(self, sig):
if self.doc_as_attr:
self.directivetype = 'attribute'
Documenter.add_directive_header(self, sig)
if not self.doc_as_attr and self.options.show_inheritance:
sourcename = self.get_sourcename()
self.add_line(u'', sourcename)
if hasattr(self.object, '__bases__') and len(self.object.__bases__):
bases = [b.__module__ in ('__builtin__', 'builtins') and
u':class:`%s`' % b.__name__ or
u':class:`~%s.%s`' % (b.__module__, b.__name__)
for b in self.object.__bases__]
self.add_line(u' ' + _(u'Bases: %s') % ', '.join(bases),
sourcename)
def add_directive_header(self, sig):
if self.doc_as_attr:
self.directivetype = 'attribute'
Documenter.add_directive_header(self, sig)
def fix(mod):
if mod == 'kivy._event':
mod = 'kivy.event'
return mod
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
self.add_line(u'', '<autodoc>')
if len(self.object.__bases__):
bases = [b.__module__ == '__builtin__' and
u':class:`%s`' % b.__name__ or
u':class:`%s.%s`' % (fix(b.__module__), b.__name__)
for b in self.object.__bases__]
self.add_line(_(u' Bases: %s') % ', '.join(bases),
'<autodoc>')
def add_directive_header(self, sig: str) -> None:
"""
Add the directive header.
:param sig:
"""
sourcename = self.get_sourcename()
if self.doc_as_attr:
self.directivetype = "attribute"
Documenter.add_directive_header(self, sig)
if self.analyzer and '.'.join(self.objpath) in self.analyzer.finals:
self.add_line(" :final:", sourcename)
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
_add_generic_bases(self)
def add_directive_header(self, sig):
if self.doc_as_attr:
self.directivetype = 'attribute'
Documenter.add_directive_header(self, sig)
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
self.add_line(u'', '<autodoc>')
if (hasattr(self.object, '__bases__')
and len(self.object.__bases__)):
bases = []
for b in self.object.__bases__:
if b.__module__ == '__builtin__':
bases.append(u':class:`%s`' % b.__name__)
elif b.__module__.startswith('gwpy.'):
bases.append(
u':class:`%s.%s`' %
(b.__module__.rsplit('.', 1)[0], b.__name__))
else:
bases.append(u':class:`%s.%s`' %
(b.__module__, b.__name__))
self.add_line(u' Bases: %s' % ', '.join(bases), '<autodoc>')
def add_directive_header(self, sig):
if self.doc_as_attr:
self.directivetype = 'attribute'
Documenter.add_directive_header(self, sig)
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
self.add_line(u'', '<autodoc>')
if (hasattr(self.object, '__bases__') and
len(self.object.__bases__)):
bases = []
for b in self.object.__bases__:
if b.__module__ == '__builtin__':
bases.append(u':class:`%s`' % b.__name__)
elif b.__module__.startswith('gwpy.'):
bases.append(u':class:`%s.%s`'
% (b.__module__.rsplit('.', 1)[0],
b.__name__))
else:
bases.append(u':class:`%s.%s`'
% (b.__module__, b.__name__))
self.add_line(u' Bases: %s' % ', '.join(bases),
'<autodoc>')
def add_directive_header(self, sig: str) -> None:
"""
Add the directive header.
:param sig:
"""
sourcename = self.get_sourcename()
if self.doc_as_attr:
self.directivetype = "attribute"
Documenter.add_directive_header(self, sig)
if self.analyzer and '.'.join(self.objpath) in self.analyzer.finals:
self.add_line(" :final:", sourcename)
# add inheritance info, if wanted
if not self.doc_as_attr and self.options.show_inheritance:
self.add_line('', sourcename)
bases = []
if (hasattr(self.object, "__orig_bases__")
and len(self.object.__orig_bases__)
and get_origin(self.object.__orig_bases__[0]) is
self.object.__bases__[0]):
# Last condition guards against classes that don't directly subclass a Generic.
bases = [
format_annotation(b) for b in self.object.__orig_bases__
]
elif hasattr(self.object, "__bases__") and len(
self.object.__bases__):
bases = [format_annotation(b) for b in self.object.__bases__]
if bases:
self.add_line(" " + _("Bases: %s") % ", ".join(bases),
sourcename)
