- 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).
- docmodule(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
- Produce HTML documentation for a module object.
- escape(value: Any) -> str
- HTML safe repr and escape
- file_link(url: str, path: str) -> str
- Make a link to source file.
- format_tree(tree: list[typing.Any], modname: str, parent: Any | None = None) -> str
- Creates a representation of class inheritance.
- getdoc(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
- Get the doc string or comments for an object.
- getdocloc(the_object: pydoc_fork.inspector.custom_types.TypeLike, basedir: str = 'C:\\Users\\matth\\AppData\\Local\\Programs\\Python\\Python314\\Lib') -> str | None
- Return the location of module docs or None
- heading(title: str, extras: str = '', nav_links: collections.abc.Sequence[str] | None = None) -> str
- Format a page heading.
- isdata(the_object: Any) -> bool
- Check if an object is of a type that probably means it's data.
- 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.
- 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.
- modulelink(the_object: pydoc_fork.inspector.custom_types.TypeLike) -> str
- Make a link for a module.
- 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.
- visiblename(name: str, all_things: list[str] | None = None, obj: Any | None = None) -> bool
- Decide whether to show documentation on a variable.