|
|
- bigsection(title: str, fgcol: str, bgcol: str, contents: str, width: int = 6, prelude: str = '', marginalia: str = '', gap: str = ' ') -> str
- Format a section with a big heading.
- docclass(the_object: pydoc_fork.inspector.custom_types.TypeLike, name: str = '', mod: str = '', funcs: Optional[Dict[str, str]] = None, classes: Optional[Dict[str, str]] = None) -> str
- Produce HTML documentation for a class object.
- 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: 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.
- document(the_object: pydoc_fork.inspector.custom_types.TypeLike, 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.
- index(directory: str, shadowed: Optional[Dict[str, Any]] = 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: Union[Sequence[Tuple[Any, str, Any, int]], Sequence[Tuple[str, Any]]], the_format: Callable[[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: pydoc_fork.inspector.custom_types.TypeLike, name: str) -> str
- Compose two functions
|