pydoc_fork (26 February 2001)
index
../../pydoc_fork/__init__.py

Generate Python documentation in HTML.

 
Package Contents
 
__main__
commands
inspector (package)
reporter (package)
settings

 
`from` Modules
 
pydoc_fork.inspector.custom_types
pydoc_fork.inspector.utils
pydoc_fork.inspector.path_utils
shutil
pydoc_fork.commands
pydoc_fork.inspector.module_utils
pydoc_fork.reporter.format_page

 
Functions
 
calculate_file_name(name: str, output_folder: str) -> str
Returns name. If this was written, what would its name be
copy2(src, dst, *, follow_symlinks=True)
Copy data and metadata. Return the file's destination.
 
Metadata is copied with copystat(). Please see the copystat function
for more information.
 
The destination may be a directory.
 
If follow_symlinks is false, symlinks won't be followed. This
resembles GNU's "cp -P src dst".
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: Union[pydoc_fork.inspector.custom_types.TypeLike, str], output_folder: str, force_load: bool = False) -> Optional[str]
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: pydoc_fork.inspector.custom_types.TypeLike, name: str) -> str
Compose two functions
resolve(thing: Union[str, Any], force_load: bool = False) -> Tuple[Any, 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.

 
Data
  LOGGER = <Logger pydoc_fork.commands (WARNING)>
__author__ = 'Ka-Ping Yee <ping@lfw.org>'
__credits__ = 'Guido van Rossum, for an excellent programming l...erlain, for the first implementation of textdoc.\n'
__date__ = '26 February 2001'

 
Author
  Ka-Ping Yee <ping@lfw.org>

 
Credits
  Guido van Rossum, for an excellent programming language.
Tommy Burnette, the original creator of manpy.
Paul Prescod, for all his work on onlinehelp.
Richard Chamberlain, for the first implementation of textdoc.