pydoc_fork.reporter.format_routine
index
../../pydoc_fork/reporter/format_routine.py

Roughly a UI component for routines

 
Modules
 
pydoc_fork.reporter.inline_styles
inspect

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

 
Functions
 
classlink(the_object: Union[pydoc_fork.inspector.custom_types.TypeLike, type], modname: str) -> str
Make a link for a class.
disabled_text(text: str) -> str
Wrap in grey
docroutine(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '', mod: str = '', funcs: Optional[Dict[str, Any]] = None, classes: Optional[Dict[str, Any]] = None, methods: Optional[Dict[str, Any]] = None, class_object: Optional[pydoc_fork.inspector.custom_types.TypeLike] = None) -> str
Produce HTML documentation for a function or method object.
escape(value: Any) -> str
HTML safe repr and escape
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.