rez icon indicating copy to clipboard operation
rez copied to clipboard

Document plugin settings

Open BryceGattis opened this issue 1 year ago • 0 comments

As a rez user, I'd like plugin settings to be documented in our documentation so I can easily change their settings.

Related Issues/PRs

  • #1692 (normalizes all plugin rezconfig files to Python)
  • https://github.com/AcademySoftwareFoundation/rez/pull/1689#issuecomment-2002575684 (JC describing the issue)

Note that we now have a proper documentation for plugins (https://rez.readthedocs.io/en/stable/plugins.html) and it'll be improved even more with https://github.com/AcademySoftwareFoundation/rez/pull/1872.

Requirements:

  • Must be automatically generated like the rest of the settings in https://rez.readthedocs.io/en/stable/configuring_rez.html#configuration-settings.
  • Must either live in https://rez.readthedocs.io/en/stable/configuring_rez.html#configuration-settings or https://rez.readthedocs.io/en/stable/plugins.html. To be discussed.

BryceGattis avatar Apr 09 '24 13:04 BryceGattis