- bigsection(title: str, contents: str = '', width: int = 6, prelude: str = '', marginalia: str = '', gap: str = ' ') -> str
- Format a section with a big heading.
- cast(typ, val)
- Cast a value to a type.
This returns the value unchanged. To the type checker this
signals that the return value has the designated type, but at
runtime we intentionally don't check anything (we want this
to be as fast as possible).
- docclass(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '', mod: str = '', funcs: dict[str, str] | None = None, classes: dict[str, str] | None = None) -> str
- Produce HTML documentation for a class object.
- docindex(modules: list) -> str
- Produce HTML documentation for an index of modules.
- docmodule(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
- Produce HTML documentation for a module object.
- docother(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '') -> str
- Produce HTML documentation for a data object.
- 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.
- document(the_object: Any, name: str = '', *args: Any) -> str
- Generate documentation for an object.
This also part of the public API of class
Types of : Module, class, routine, data descriptor, "other" are supported
Modules ignore 1st name.
Public API doesn't call with *args
Args are:
name, fdict, cdict (name twice?)
mod, funcs, classes, mdict, the_object
- document_data(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '') -> str
- Produce html documentation for a data descriptor.
- heading(title: str, extras: str = '', nav_links: collections.abc.Sequence[str] | None = None) -> str
- Format a page heading.
- index(directory: str, shadowed: dict[str, Any] | None = None) -> str
- Generate an HTML index for a directory of modules.
- module_package_link(module_package_info: tuple[str, str, str, str]) -> str
- Make a link for a module or package to display in an index.
- multicolumn(the_list: collections.abc.Sequence[typing.Any], the_format: collections.abc.Callable[[typing.Any], str], cols: int = 4) -> str
- Format a list of items into a multi-column list.
- page(title: str, contents: str) -> str
- Format an HTML page.
This is part of the public API
- render(title: str, the_object: Any, name: str) -> str
- Compose two functions