Toggle navigation

ClassDoc

class ClassDoc

Bases: Generic[configpile.util._Class]

Stores information about Sphinx autodoc-style documentation for a class

See https://pypi.org/project/class-doc/

Attributes

Note: attributes inherited from parent classes are not shown here, if any

docs	Documentation for the class and parents

Methods

make	Retrieves the documentation for the attributes of a class
raw	Returns the raw documentation string for the given attribute

List of members of ClassDoc

docs: Sequence[Mapping[str, Sequence[str]]]

Documentation for the class and parents

raw(attribute_name)

Returns the raw documentation string for the given attribute

This walks through the base classes in the Method Resolution Order and returns the first string encountered.

Parameters

attribute_name (str) – Attribute name

Return type

Optional[Sequence[str]]

static make(t)

Retrieves the documentation for the attributes of a class

Parameters

t (Type[TypeVar(_Class)]) – Class type to investigate

Return type

ClassDoc[TypeVar(_Class)]

Returns

A ClassDoc instance

__init__(docs)

static __new__(cls, *args, **kwds)

previous

filter_types_single