Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Applications: update inline docs for only_available in applications addon settings #471

Merged
merged 9 commits into from
May 29, 2024
21 changes: 19 additions & 2 deletions server_addon/applications/server/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,17 @@ def validate_unique_name(cls, value):


class ApplicationsSettings(BaseSettingsModel):
"""Applications settings"""
"""Applications settings

Define applications are available to your studio, locations of their
executables, and their additional environments.
MustafaJafar marked this conversation as resolved.
Show resolved Hide resolved

AYON uses the following definitions to populate the applications list
in project anatomy > attributes.
So, You'd still need modify your project anatomy settings.
MustafaJafar marked this conversation as resolved.
Show resolved Hide resolved

Use shortcut **a+a** to navigate to project anatomy.
MustafaJafar marked this conversation as resolved.
Show resolved Hide resolved
"""

maya: AppGroupWithPython = SettingsField(
default_factory=AppGroupWithPython, title="Autodesk Maya")
Expand Down Expand Up @@ -210,7 +220,14 @@ class ApplicationsAddonSettings(BaseSettingsModel):
scope=["studio"]
)
only_available: bool = SettingsField(
True, title="Show only available applications")
True,
title="Show only available applications",
description="Enable to show available applications in AYON Launcher"
" i.e. Show them if they are installed on the user"
" machine. Note: AYON Launcher shows only the selected"
" applications in project anatomy and this is another"
" filter to ignore uninstalled apps."
MustafaJafar marked this conversation as resolved.
Show resolved Hide resolved
)

@validator("tool_groups")
def validate_unique_name(cls, value):
Expand Down
Loading