rez.package_help

class rez.package_help.PackageHelp(package_name, version_range=None, paths=None, verbose=False)[source]

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.

open(section_index=0)[source]: Launch a help section.

classmethod open_rez_manual()[source]: Open the Rez user manual.

print_info(buf=None)[source]: Print help sections.

property sections: Returns a list of (name, uri) 2-tuples.

property success: Return True if help was found, False otherwise.