zut.command.parse_doc

zut.command.parse_doc(doc: str | None) → ParsedDoc

Parse a function or module docstring into a help, description, epilog, param_helps tuple.

The docstring must be written in reStructuredText/Sphinx format (as suggested by PEP 287).

Returns:

Tuple (help, description, epilog, param_helps).