qrenderer.exclude_classes

exclude_classes(spec)

Exclude the classes in a class or module from the documentation

When a class or module has deprecated classes or a module has deprecated classes, we may want to exclude them from the documentation. Use this function in your _renderer.py file to specify them.

Parameters

spec : dict[str, str | Sequence[str]]

Parent object path and the class(es) to exclude. The object path is as shown on the API page and not the canonical path. e.g.

Examples

Assuming we are documenting ClassA with the deprecated contained class marked as shown below.

class ClassA:
    class Contained1:  # deprecated
        pass
    class Contained2:
        pass

We would use this to exclude the class from the documentation.

from qrenderer import exclude_classes

exclude_classes({
    "package.ClassA": "Contained1",
})