NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-14 09:51:22 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Convert PluginConfig attrs list to a table

Browse Source
This commit is contained in:
Jeremy Stretch 2020-03-26 12:03:10 -04:00
parent d316d8ac61
commit 62f14f0473
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/plugins/development.md
View File

@ -91,21 +91,23 @@ class AnimalSoundsConfig(PluginConfig):
#### PluginConfig Attributes #### PluginConfig Attributes
* `name` - Raw plugin name; same as the plugin's source directory | Name | Description |
* `verbose_name` - Human-friendly name for the plugin | ---- | ----------- |
* `version` - Current release ([semantic versioning](https://semver.org/) is encouraged) | `name` | Raw plugin name; same as the plugin's source directory |
* `description` - Brief description of the plugin's purpose | `verbose_name` | Human-friendly name for the plugin |
* `author_name` - Name of plugin's author | `version` | Current release ([semantic versioning](https://semver.org/) is encouraged) |
* `author_email` - Author's public email address | `description` | Brief description of the plugin's purpose |
* `base_url` - Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. | `author_name` | Name of plugin's author |
* `required_settings`: A list of any configuration parameters that **must** be defined by the user | `author_email` | Author's public email address |
* `default_settings`: A dictionary of configuration parameter names and their default values | `base_url` | Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used. |
* `min_version`: Minimum version of NetBox with which the plugin is compatible | `required_settings` | A list of any configuration parameters that **must** be defined by the user |
* `max_version`: Maximum version of NetBox with which the plugin is compatible | `default_settings` | A dictionary of configuration parameters and their default values |
* `middleware`: A list of middleware classes to append after NetBox's build-in middleware | `min_version` | Minimum version of NetBox with which the plugin is compatible |
* `caching_config`: Plugin-specific cache configuration | `max_version` | Maximum version of NetBox with which the plugin is compatible |
* `template_content`: The dotted path to the list of template content classes (default: `template_content.template_contnet`) | `middleware` | A list of middleware classes to append after NetBox's build-in middleware |
* `menu_items`: The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) | `caching_config` | Plugin-specific cache configuration
| `template_content` | The dotted path to the list of template content classes (default: `template_content.template_contnet`) |
| `menu_items` | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`) |
### Install the Plugin for Development ### Install the Plugin for Development