pydoc_fork

pydoc_fork.reporter.format_routine

 

Roughly a UI component for routines

Modules

`from` Modules

Functions

classlink(the_object: pydoc_fork.inspector.custom_types.TypeLike | type, modname: str) -> str
Make a link for a class.
disabled_text(text: str) -> str
Wrap in gray
docroutine(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '', mod: str = '', funcs: dict[Any, str] | None = None, classes: dict[Any, str] | None = None, methods: dict[Any, str] | None = None, class_object: pydoc_fork.inspector.custom_types.TypeLike | None = 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: dict[Any, str] | None = None, classes: dict[Any, str] | None = None, methods: dict[Any, str] | None = None) -> str
Replace all linkable things with links of appropriate syntax.
 
Handle either an ad hoc markup language, or RST or Markdown.
funcs, classes, methods are name/symbol to URL maps.

Data

JINJA_ENV = <jinja2.environment.Environment object>
LOGGER = <Logger pydoc_fork.reporter.format_routine (WARNING)>