def get_subclasses_bullets(cls, abbrev=True, style=None, only_leaves=False):
"""
Return a formatted bullet list of the subclasses of the given class,
including a short description for each.
"""
return '\n'.join(f'* {subcls}: {doc}' for subcls, doc in sorted(
(get_sphinx_name(subcls, style=style, abbrev=abbrev),
get_short_doc(subcls))
for subcls in get_subclasses(cls, only_leaves=only_leaves)))
def make_entry(entry):
msg = entry.get('msg') or ''
removed_in = entry.get('removed_in')
if removed_in is None:
removed_in = ''
else:
removed_in = '*Removed in: {}*\n\n'.format(format_version(removed_in))
name = get_sphinx_name(entry['obj'], style='rst')
replaced_by = entry.get('replaced_by')
if replaced_by is None:
replaced_by = ''
else:
replaced_by = '*Replaced by:* {}\n\n'.format(get_sphinx_name(replaced_by, style='rst'))
return "* - {name}{msg}{replaced_by}{removed_in}".format(
name=indent(name + '\n\n'),
msg=indent(msg + '\n\n' if msg else ''),
replaced_by=indent(replaced_by),
removed_in=indent(removed_in),
)