pydoc_fork.reporter.format_data
index
../../pydoc_fork/reporter/format_data.py

Roughly a UI component for variables and their values

 
`from` Modules
 
pydoc_fork.inspector.custom_types
pydoc_fork.inspector.utils
pydoc_fork.reporter.formatter_html

 
Functions
 
document_data(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '') -> str
Produce html documentation for a data descriptor.
getdoc(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
Get the doc string or comments for an object.
markup(text: str, funcs: Optional[Dict[str, str]] = None, classes: Optional[Dict[str, str]] = None, methods: Optional[Dict[str, str]] = None) -> str
Replace all linkable things with links of appropriate syntax.
 
Handle either an adhoc markup language, or RST or Markdown.
funcs, classes, methods are name/symbol to URL maps.