Skip to content

docs module¶

Utilities for documentation.

prepare_for_doc function¶

prepare_for_doc(
    obj,
    replace=None,
    path=None
)

Prepare object for use in documentation.

to_doc function¶

to_doc(
    obj,
    replace=None,
    path=None,
    **kwargs
)

Convert object to a JSON string.

Documented class¶

Documented()

Abstract class for documenting self.

Note

Won't get converted into a string in prepare_for_doc().

Subclasses

to_doc method¶

Documented.to_doc(
    **kwargs
)

Convert to a doc.

SafeToStr class¶

SafeToStr()

Class that can be safely converted into a string in prepare_for_doc().

Subclasses