mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-19 06:27:49 +00:00
Fix doc links / setup (#13140)
* fix various doc links * update generated start page * switch to properdocs * bump deps * pin mkdocs before 2.0 so deps dont break * fix link
This commit is contained in:
1 parent
d96174cddb
commit
b2c2f926e7
17 files changed
+113
-99
No files matched your search
@@ -7,7 +7,7 @@ The API schema as documented below is generated using the [drf-spectactular](htt
|
||||
|
||||
## API Version
|
||||
|
||||
This documentation is for API version: `459`
|
||||
This documentation is for API version: `568`
|
||||
|
||||
!!! tip "API Schema History"
|
||||
We track API schema changes, and provide a snapshot of each API schema version in the [API schema repository](https://github.com/inventree/schema/).
|
||||
@@ -33,7 +33,7 @@ API schema documentation is split into the following categories:
|
||||
| [External Order Management](./schema/order.md) | External Order Management |
|
||||
| [Parts and Part Categories](./schema/part.md) | Parts and Part Categories |
|
||||
| [Plugin Functionality](./schema/plugins.md) | Plugin Functionality |
|
||||
| [Pricing Information](./schema/pricing.md) | Part Pricing |
|
||||
| [Part Pricing](./schema/pricing.md) | Part Pricing |
|
||||
| [Report Generation](./schema/report.md) | Report Generation |
|
||||
| [Settings Management](./schema/settings.md) | Settings Management |
|
||||
| [Stock and Stock Locations](./schema/stock.md) | Stock and Stock Locations |
|
||||
|
||||
@@ -27,7 +27,7 @@ Barcodes can be linked with the following data model types:
|
||||
|
||||
- [Part](../part/index.md#part)
|
||||
- [Stock Item](../stock/index.md#stock-item)
|
||||
- [Stock Location](../stock/index.md#stock-location)
|
||||
- [Stock Location](../stock/index.md#stock-locations)
|
||||
- [Supplier Part](../purchasing/supplier.md#supplier-parts)
|
||||
- [Purchase Order](../purchasing/purchase_order.md#purchase-orders)
|
||||
- [Sales Order](../sales/sales_order.md#sales-orders)
|
||||
|
||||
@@ -18,7 +18,7 @@ Tags can be attached to the following InvenTree objects:
|
||||
- [Manufacturer Parts](../purchasing/manufacturer.md#manufacturer-parts)
|
||||
- [Companies](./company.md)
|
||||
- [Stock Items](../stock/index.md#stock-item)
|
||||
- [Stock Locations](../stock/index.md#stock-location)
|
||||
- [Stock Locations](../stock/index.md#stock-locations)
|
||||
- [Build Orders](../manufacturing/build.md)
|
||||
- [Purchase Orders](../purchasing/purchase_order.md)
|
||||
- [Sales Orders](../sales/sales_order.md)
|
||||
|
||||
@@ -54,7 +54,7 @@ Code styles are generally only applied to the code in the `src/` directory.
|
||||
|
||||
InvenTree's backend is a Django application. It is generally structured in a way that follows Django's conventions, but also includes some customizations and extensions to support the specific needs of InvenTree.
|
||||
Most remarkable deviations from the Django standard are:
|
||||
- Manipulation of the django app mechanisms to enable the [plugin system](#plugin-system)
|
||||
- Manipulation of the django app mechanisms to enable the [plugin system](../plugins/index.md)
|
||||
- Usage of a custom role-mapping system to make permissions more approachable
|
||||
|
||||
The backend aims to be:
|
||||
|
||||
@@ -75,7 +75,7 @@ The following options are available when completing a build output:
|
||||
| Option | Description |
|
||||
| --- | --- |
|
||||
| Status | The [stock status](../stock/status.md) for the completed outputs |
|
||||
| Location | The [stock location](../stock/index.md#stock-location) where the outputs will be located |
|
||||
| Location | The [stock location](../stock/index.md#stock-locations) where the outputs will be located |
|
||||
| Notes | Any additional notes associated with the completion of these outputs |
|
||||
| Accept Incomplete Allocation | If selected, this option allows [tracked build outputs](./allocate.md#tracked-build-outputs) to be completed in the case where required BOM items have not been fully allocated |
|
||||
|
||||
|
||||
@@ -64,7 +64,7 @@ Next, the creator tool will prompt you to select the features you wish to includ
|
||||
|
||||
#### Select Mixins
|
||||
|
||||
Select the [plugin mixins](./index.md/#plugin-mixins) you wish to use in your plugin:
|
||||
Select the [plugin mixins](./develop.md#plugin-mixins) you wish to use in your plugin:
|
||||
|
||||
{{ image("plugin/plugin-creator-mixins.png", "Plugin Mixins") }}
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ We strongly recommend that you use the [Plugin Creator](./creator.md) tool when
|
||||
|
||||
## Determine Requirements
|
||||
|
||||
Before starting, you should have a clear understanding of what you want your plugin to do. In particular, consider the functionality provided by the available [plugin mixins](./index.md#plugin-mixins), and whether your plugin can be built using these mixins.
|
||||
Before starting, you should have a clear understanding of what you want your plugin to do. In particular, consider the functionality provided by the available [plugin mixins](#plugin-mixins), and whether your plugin can be built using these mixins.
|
||||
|
||||
Consider the use-case for your plugin and define the exact function of the plugin, maybe write it down in a short readme. Then pick the mixins you need (they help reduce custom code and keep the system reliable if internal calls change).
|
||||
|
||||
@@ -27,7 +27,7 @@ Consider the use-case for your plugin and define the exact function of the plugi
|
||||
|
||||
### Define Metadata
|
||||
|
||||
Do not forget to [declare the metadata](./index.md#plugin-options) for your plugin, those will be used in the settings. At least provide a web link so users can file issues / reach you.
|
||||
Do not forget to [declare the metadata](#plugin-options) for your plugin, those will be used in the settings. At least provide a web link so users can file issues / reach you.
|
||||
|
||||
### Development Guidelines
|
||||
|
||||
@@ -36,7 +36,7 @@ If you want to make your life easier, try to follow these guidelines; break wher
|
||||
- Keep it simple - more that 1000 LOC are normally to much for a plugin
|
||||
- Use mixins where possible - we try to keep coverage high for them so they are not likely to break
|
||||
- Do not use internal functions - if a functions name starts with `_` it is internal and might change at any time
|
||||
- Keep you imports clean - the APIs for plugins and mixins are young and evolving (see [here](./index.md#imports)). Use
|
||||
- Keep you imports clean - the APIs for plugins and mixins are young and evolving (see [here](#imports)). Use
|
||||
```
|
||||
from plugin import InvenTreePlugin, registry
|
||||
from plugin.mixins import APICallMixin, SettingsMixin, ScheduleMixin, BarcodeMixin
|
||||
|
||||
@@ -249,7 +249,7 @@ When distributing a custom UI plugin, the plugin should include the necessary fr
|
||||
|
||||
The simplest (and recommended) way to achieve this is to distribute the compiled javascript files with the plugin package, in a top-level `static` directory. This directory will be automatically collected by InvenTree when the plugin is installed, and the files will be copied to the appropriate location.
|
||||
|
||||
Read more about [static plugin files](../index.md#static-files) for more information.
|
||||
Read more about [static plugin files](../develop.md#static-files) for more information.
|
||||
|
||||
## Sample Plugin
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ The following models can be tagged:
|
||||
- [Supplier Parts](../purchasing/supplier.md#supplier-parts)
|
||||
- [Manufacturer Part](../purchasing/manufacturer.md#manufacturer-parts)
|
||||
- [Stock Items](../stock/index.md#stock-item)
|
||||
- [Stock Location](../stock/index.md#stock-location)
|
||||
- [Stock Location](../stock/index.md#stock-locations)
|
||||
|
||||
|
||||
## Accessing Tags
|
||||
|
||||
@@ -53,7 +53,7 @@ After the Plugin Creator has finished you should have a new project that looks l
|
||||
|
||||
#### A Brief Overview of the Environment
|
||||
|
||||
`attachment_carousel` contains several files, but the main file is `core.py` which is the Python entry point for the plugin. Once created, this folder will also contain the bundled frontend code and any [static file assets](./index.md#static-files).
|
||||
`attachment_carousel` contains several files, but the main file is `core.py` which is the Python entry point for the plugin. Once created, this folder will also contain the bundled frontend code and any [static file assets](./develop.md#static-files).
|
||||
|
||||
`frontend/src` contains `Panel.tsx' which is the frontend React TypeScript code.
|
||||
|
||||
@@ -511,7 +511,7 @@ function AttachmentCarouselPanel({context}: {context: InvenTreePluginContext;})
|
||||
...
|
||||
```
|
||||
|
||||
The reference requires the host and the [plugin-name](./index.md##static-files). Rather than statically coding these references, the host reference may be retrieved via the context and the plugin-name may be passed via additional context data. In this example it is passed as the `slug`, as by default the slug is the plugin name. Add this additional context data via `core.py`,
|
||||
The reference requires the host and the [plugin-name](./develop.md#static-files). Rather than statically coding these references, the host reference may be retrieved via the context and the plugin-name may be passed via additional context data. In this example it is passed as the `slug`, as by default the slug is the plugin name. Add this additional context data via `core.py`,
|
||||
|
||||
``` diff
|
||||
panels.append({
|
||||
|
||||
@@ -75,7 +75,7 @@ Templates (whether for generating [reports](./report.md) or [labels](./labels.md
|
||||
| [purchaseorder](#purchase-order) | A [Purchase Order](../purchasing/purchase_order.md) instance |
|
||||
| [transferorder](#transfer-order) | A [Transfer Order](../stock/transfer_order.md) instance |
|
||||
| [stockitem](#stock-item) | A [StockItem](../stock/index.md#stock-item) instance |
|
||||
| [stocklocation](#stock-location) | A [StockLocation](../stock/index.md#stock-location) instance |
|
||||
| [stocklocation](#stock-location) | A [StockLocation](../stock/index.md#stock-locations) instance |
|
||||
| [part](#part) | A [Part](../part/index.md) instance |
|
||||
|
||||
### Company
|
||||
@@ -154,11 +154,11 @@ For the fields and properties available on the underlying `StockItem` instance,
|
||||
|
||||
### Stock Location
|
||||
|
||||
When printing a report or label against a [StockLocation](../stock/index.md#stock-location) object, the following context variables are available:
|
||||
When printing a report or label against a [StockLocation](../stock/index.md#stock-locations) object, the following context variables are available:
|
||||
|
||||
{{ report_context("models", "stocklocation") }}
|
||||
|
||||
For the fields and properties available on the underlying `StockLocation` instance, refer to the [Model Context](model_context.md#stock-location) page.
|
||||
For the fields and properties available on the underlying `StockLocation` instance, refer to the [Model Context](model_context.md) page.
|
||||
|
||||
### Part
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ The following report templates are provided "out of the box" and can be used as
|
||||
| [Return Order](#return-order) | [ReturnOrder](../sales/return_order.md) | Return Order report |
|
||||
| [Sales Order](#sales-order) | [SalesOrder](../sales/sales_order.md) | Sales Order report |
|
||||
| [Sales Order Shipment](#sales-order-shipment) | [SalesOrderShipment](../sales/sales_order.md) | Sales Order Shipment report |
|
||||
| [Stock Location](#stock-location) | [StockLocation](../stock/index.md#stock-location) | Stock Location report |
|
||||
| [Stock Location](#stock-location) | [StockLocation](../stock/index.md#stock-locations) | Stock Location report |
|
||||
| [Test Report](#test-report) | [StockItem](../stock/index.md#stock-item) | Test Report |
|
||||
| [Transfer Order](#transfer-order) | [TransferOrder](../stock/transfer_order.md) | Transfer Order report |
|
||||
| [Selected Stock Items Report](#selected-stock-items-report) | [StockItem](../stock/index.md#stock-item) | Selected Stock Items report |
|
||||
@@ -76,8 +76,8 @@ The following label templates are provided "out of the box" and can be used as a
|
||||
| [Part](#part-label) | [Part](../part/index.md) | Part label (QR code and part name) |
|
||||
| [Part (Code128)](#part-label-code128) | [Part](../part/index.md) | Part label (Code128 barcode) |
|
||||
| [Stock Item](#stock-item-label) | [StockItem](../stock/index.md#stock-item) | Stock Item label |
|
||||
| [Stock Location](#stock-location-label) | [StockLocation](../stock/index.md#stock-location) | Stock Location label (QR code) |
|
||||
| [Stock Location (with text)](#stock-location-label-with-text) | [StockLocation](../stock/index.md#stock-location) | Stock Location label (QR code and location details) |
|
||||
| [Stock Location](#stock-location-label) | [StockLocation](../stock/index.md#stock-locations) | Stock Location label (QR code) |
|
||||
| [Stock Location (with text)](#stock-location-label-with-text) | [StockLocation](../stock/index.md#stock-locations) | Stock Location label (QR code and location details) |
|
||||
|
||||
### Build Line Label
|
||||
|
||||
|
||||
Reference in new issue
Block a user