- calculate_file_name(name: str, output_folder: str) -> str | None
- Returns name. If this was written, what would its name be. Returns None for degenerate names.
- describe(thing: pydoc_fork.inspector.custom_types.TypeLike) -> str
- Produce a short description of the given thing.
- document_directory(source_directory: str, output_folder: str, for_only: str = '') -> list[str]
- Write out HTML documentation for all modules in a directory tree.
- document_one(thing: pydoc_fork.inspector.custom_types.TypeLike | str, output_folder: str, force_load: bool = False) -> str | None
- Write HTML documentation to a file in the current directory.
- locate_file(file_name: str, executing_file: str) -> str
- Find file relative to a source file, e.g.
locate_file("foo/bar.txt", __file__)
Succeeds regardless to context of execution
- modules_in_current() -> list[str]
- Convert . shortcut into list of modules
- process_path_or_dot_name(files: list[str], output_folder: str, overwrite_existing: bool = False) -> list[str]
- Generate html documentation for all modules found at paths or
dot notation module names.
Args:
files:
output_folder:
overwrite_existing:
Returns:
List of successfully documented modules
- render(title: str, the_object: Any, name: str) -> str
- Compose two functions
- resolve(thing: str | Any, force_load: bool = False) -> tuple[typing.Any, typing.Any]
- Given an object or a path to an object, get the object and its name.
- write_docs_live_module(output_folder: str, total_third_party: int = 0, skip_if_written: bool = False) -> list[str]
- Write out HTML documentation for all modules in a directory tree.
- write_docs_per_module(modules: list[str], output_folder: str, skip_if_written: bool = False) -> list[str]
- Write out HTML documentation for all modules in a directory tree.