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, version_range=None, paths=None, verbose=False)¶
Create a PackageHelp object.
- Parameters:
package_name (str) – Package to search.
version_range (VersionRange) – Versions to search.
- property success¶
Return True if help was found, False otherwise.
- property sections¶
Returns a list of (name, uri) 2-tuples.
- open(section_index=0)¶
Launch a help section.
- print_info(buf=None)¶
Print help sections.
- classmethod open_rez_manual()¶
Open the Rez user manual.