footprints.doc¶

Footprint’s docstring generator

Module Attributes¶

footprints.doc.visibility = <footprints.priorities.PrioritySet object>: Predefined documentation visibilities

Functions¶

footprints.doc.format_docstring(fp, formating_style, abstractfpobj=False)[source]¶: Call the appropriate formatting function given formating_style.

footprints.doc.set_after(visibilityref, *args)[source]¶: Set args visibility after specified visibilityref.

footprints.doc.set_before(visibilityref, *args)[source]¶: Set args visibility before specified visibilityref.