inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-18 13:15:27 +00:00
Code Activity

Update plugin docs

Browse Source 
- Create separate files for each mixin
- Remove old "report" plugin docs
This commit is contained in:
Oliver
2022-01-13 09:37:09 +11:00
parent 615f84961b
commit 836b5bc741
13 changed files with 179 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/extend/plugins/integration.md
View File

@ -24,12 +24,7 @@ WEBSITE = None # Website for the plugin, developer etc. -> is shown in plugin o
#### Installing a Plugin
Plugins can either be loaded from paths in the InvenTree install directory or as a plugin installed via pip. We recommend installation via pip as this enables hassle-free upgrades.
For development new plugins can be placed ina a subdirectroy in `src/InvenTree/plugins`. Built-In plugins ship in `src/InvenTree/plugin/builtin`. To achive full unit-testing for all mixins there are some sample implementations in `src/InvenTree/plugin/samples`. These are not loaded in production mode.
##
#### Mixins
Common use cases are covered by pre-supplied modules in the form of mixins (similar to how [django](https://docs.djangoproject.com/en/stable/topics/class-based-views/mixins/) does it). Each mixin enables the integration into a specific area of InvenTree. Sometimes it also enhances the plugin with helper functions to supply often used functions out-of-the-box.