rez.package_help

class rez.package_help.PackageHelp

Bases: object

Object for extracting and viewing help for a package.

Given a package and version range, help will be extracted from the latest package in the version range that provides it.

__init__(package_name: str, version_range: VersionRange | None = None, paths=None, verbose: bool = False) → None

Create a PackageHelp object.

Parameters:

• package_name (str) – Package to search.

• version_range (VersionRange) – Versions to search.

property success: bool

Return True if help was found, False otherwise.

property sections: list[list[str]]

Returns a list of (name, uri) 2-tuples.

open(section_index: int = 0) → None

Launch a help section.

print_info(buf=None) → None

Print help sections.

classmethod open_rez_manual() → None

Open the Rez user manual.