inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-28 03:26:45 +00:00
Code

Update plugin docs (#9144)

Browse Source 
- Add examples for new types of settings features
This commit is contained in:
Oliver 2025-02-22 17:47:33 +11:00 committed by GitHub
parent bd7e515856
commit 4cacf83294
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/docs/extend/plugins/settings.md
View File

@ -50,7 +50,7 @@ class PluginWithSettings(SettingsMixin, InvenTreePlugin):
}, },
'NUMBER': { 'NUMBER': {
'name': _('A Name'), 'name': _('A Name'),
'description': _('Descripe me here'), 'description': _('Describe me here'),
'default': 6, 'default': 6,
'validator': [ 'validator': [
int, int,
@ -58,6 +58,20 @@ class PluginWithSettings(SettingsMixin, InvenTreePlugin):
MaxValueValidator(25) MaxValueValidator(25)
] ]
}, },
'ASSEMBLY': {
'name': _('Assembled Part'),
'description': _('Settings can point to internal database models'),
'model': 'part.part',
'filters': {
'active': True,
'assembly': True
}
},
'GROUP': {
'name': _('User Group'),
'description': _('Select a group of users'),
'model': 'auth.group'
},
'HIDDEN_SETTING': { 'HIDDEN_SETTING': {
'name': _('Hidden Setting'), 'name': _('Hidden Setting'),
'description': _('This setting is hidden from the automatically generated plugin settings page'), 'description': _('This setting is hidden from the automatically generated plugin settings page'),