`papyri.doc:GeneratedDoc`

source: /papyri/doc.py :98

Signature

class GeneratedDoc ( * args : Any , ** kwargs : Any ) → None

Members

__init__
__repr__
_deserialise
new
slots

Summary

An object containing information about the documentation of an arbitrary object.

Extended Summary

Instead of GeneratedDoc being a NumpyDocString, I'm thinking of them having a NumpyDocString. This helps with arbitrary documents (module, examples files) that cannot be parsed by Numpydoc, as well as links to external references, like images generated.

Aliases

papyri.doc.GeneratedDoc