autoclasstoc.utils

Functions

comma_separated_list(x)

Parse a restructured text option as a comma-separated list of strings.

filter_attrs(attrs, predicate)

Remove attributes for which the given predicate function returns False.

find_attrs(cls)

Return a dictionary containing every attribute of the given class.

find_inherited_attrs(cls)

Return a dictionary mapping parent classes to the attributes inherited from those classes.

get_cls_xref(cls[, cant_import])

Return a RST-formatted string that references the given class.

join(*strs[, sep])

Concatenate the given strings, excluding any that are empty.

load_class(mod_name, cls_name)

Import the given class from the given module.

make_container()

Make a container node to identify elements associated with the autoclasstoc directive.

make_inherited_details(state, parent[, ...])

Make a collapsible node to contain information about inherited attributes.

make_links(state, attrs, cls)

Make links to the given class attributes.

make_rubric(title)

Make an informal header.

make_toc(state, cls, sections)

Create the class TOC.

nodes_from_rst(state, rst)

Create nodes from the given restructured text.

pick_class(qual_name, env)

Figure out which class to make the TOC for.

pick_sections(sections[, exclude])

Determine which sections to include in the class TOC.

strip_p(nodes)

Remove any top-level paragraph nodes.