2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-05-11 01:38:49 +00:00

Docs refactor ()

* Refactor / reognaize docs structure

* Refactor plugin docs structure

* More refactoring / cleanup

* Update build images

* Gallery updates

* Order images

* Update part docs

* Settings images

* Stock images

* Reitntroduce gallery

* Add custom icon macro

* Update icons

* Cleanup

* Fix link

* Fix internal links

* Revert some page moves

* Fix links

* Fix links
This commit is contained in:
Oliver 2025-04-22 08:18:32 +10:00 committed by GitHub
parent 9b489911e5
commit 6b08e45eac
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
240 changed files with 964 additions and 831 deletions
docs
_includes
docs
api
app
assets/images
barcode
build
indexgallery
order
part

@ -20,8 +20,7 @@
<div class="md-grid md-typeset">
<div class="mdx-hero"></div>
<h1>
<span class='fas fa-search'></span>
Page not found
<i class="ti ti-search"></i> Page not found
</h1>
</div>
</section>

@ -7,7 +7,7 @@
{% block content %}
{{ page.content }}
<style>
h1 {
@ -15,6 +15,8 @@
}
</style>
<h2 id="intuitive-inventory-management">InvenTree - Intuitive Inventory Management</h2>
<!-- Hero for landing page -->
<section class="mdx-container">
<div class="md-grid md-typeset">
@ -24,24 +26,24 @@
<div class="mdx-hero__content">
<a href="https://inventree.org" title="InvenTree Website" class="md-button">
<span class='fas fa-globe'></span> Website
<i class='ti ti-world'></i> Website
</a>
<a href="start/intro" title="Install InvenTree" class="md-button">
<span class='fas fa-server'></span> Install
<a href="start" title="Install InvenTree" class="md-button">
<i class='ti ti-server-bolt'></i> Install
</a>
<a href="app/app" title="InvenTree mobile app" class="md-button">
<span class='fas fa-mobile-alt'></span> Mobile App
<a href="app" title="InvenTree mobile app" class="md-button">
<i class='ti ti-device-mobile'></i> Mobile App
</a>
<a href="https://crowdin.com/project/inventree" title="Help translate InvenTree" class="md-button">
<span class='fas fa-language'></span> Translate
<i class='ti ti-language'></i> Translate
</a>
<a href="https://github.com/inventree/inventree" title="Explore InvenTree source code" class="md-button md-button">
<span class='fab fa-github'></span> Source Code
<i class='ti ti-code-circle'></i> Source Code
</a>
</div>
</div>
</div>
</section>
{{ page.content }}
{% endblock content %}

@ -4,10 +4,10 @@
<table>
<thead>
<tr>
<th><span class='fas fa-clipboard-list'></span> Release</th>
<th><span class='fas fa-calendar-alt'></span> Date</th>
<th><span class='fab fa-github'></span> GitHub</th>
<th><span class='fab fa-docker'></span> Docker</th>
<th>{{ icon("clipboard") }}</span> Release</th>
<th>{{ icon("calendar") }} Date</th>
<th>{{ icon("brand-github") }} GitHub</th>
<th>{{ icon("brand-docker") }} Docker</th>
</tr>
</thead>
<tbody>

@ -4,7 +4,7 @@ title: Interactive API
## Interactive API
If the server is running in [Debug Mode](../start/intro.md#debug-mode) then an interactive version of the API is available using a browser.
If the server is running in [Debug Mode](../start/index.md#debug-mode) then an interactive version of the API is available using a browser.
!!! info "Debug Mode"
This interactive API is only available when running the server in debug mode

@ -6,7 +6,7 @@ title: Bulk Deletion
While deleting items individually via the API is supported, it can prove inefficient (time consuming) when multiple items are to be deleted sequentially.
For example, if the user wishes to delete a large number items (such as lines from a [Bill of Materials](../build/bom.md)), these items are deleted sequentially, with each `DELETE` separate request requiring network transfer, database access, cleanup, etc.
For example, if the user wishes to delete a large number items (such as lines from a [Bill of Materials](../manufacturing/bom.md)), these items are deleted sequentially, with each `DELETE` separate request requiring network transfer, database access, cleanup, etc.
A much more efficient approach is to allow for "bulk deletion" of multiple database items in a single transaction. This means that only one network request is required, and only a single database access request.

@ -4,7 +4,7 @@ title: Model Metadata
## Model Metadata
The API is *self describing* in that it provides metadata about the various fields available at any given endpoint. External applications (such as the [python interface](../api/python/python.md)) can introspect the API to determine information about the model fields.
The API is *self describing* in that it provides metadata about the various fields available at any given endpoint. External applications (such as the [python interface](../api/python/index.md)) can introspect the API to determine information about the model fields.
!!! tip "API Forms"
The various forms implemented in the InvenTree web interface make heavy use of this metadata feature
@ -13,7 +13,7 @@ The API is *self describing* in that it provides metadata about the various fiel
To request metadata about a particular API endpoint, simply perform an `OPTIONS` method request against the API URL.
For example, to view the metadata available for creating a new [Part Category](../part/part.md#part-category), an `OPTIONS` request to `/api/part/category/` yields:
For example, to view the metadata available for creating a new [Part Category](../part/index.md#part-category), an `OPTIONS` request to `/api/part/category/` yields:
{% with id="api_cat_options", url="api/api_category_options.png", description="Part category options" %}
{% include 'img.html' %}

@ -6,7 +6,7 @@ title: Python Currency Support
InvenTree provides native support for multiple currencies, which can mean that data require conversion between these currencies, at defined exchange rates.
The InvenTree server maintains a set of exchange rates, which are updated periodically. These exchange rates are available via the [InvenTree API](../api.md), and can be used by the Python bindings.
The InvenTree server maintains a set of exchange rates, which are updated periodically. These exchange rates are available via the [InvenTree API](../index.md), and can be used by the Python bindings.
### CurrencyManager Class

@ -67,7 +67,7 @@ print("Minimum stock:", part.minimum_stock)
### Adding Parameters
Each [part](../../part/part.md) can have multiple [parameters](../../part/parameter.md). For the example of the sofa (above) *length* and *weight* make sense. Each parameter has a parameter template that combines the parameter name with a unit. So we first have to create the parameter templates and afterwards add the parameter values to the sofa.
Each [part](../../part/index.md) can have multiple [parameters](../../part/parameter.md). For the example of the sofa (above) *length* and *weight* make sense. Each parameter has a parameter template that combines the parameter name with a unit. So we first have to create the parameter templates and afterwards add the parameter values to the sofa.
```python
from inventree.part import Parameter
@ -190,7 +190,7 @@ item.transferStock(loc, quantity=50)
### Delete a Part
To delete a [Part instance](../../part/part.md), first in needs to be marked as *inactive* (otherwise it will throw an error):
To delete a [Part instance](../../part/index.md), first in needs to be marked as *inactive* (otherwise it will throw an error):
```python
from inventree.part import Part

@ -83,7 +83,7 @@ category = PartCategory(api, 10)
#### Multiple Items
Database items can be queried by using the `list` method for the given class. Note that arbitrary filter parameters can be applied (as specified by the [InvenTree API](../api.md)) to filter the returned results.
Database items can be queried by using the `list` method for the given class. Note that arbitrary filter parameters can be applied (as specified by the [InvenTree API](../index.md)) to filter the returned results.
```python
from inventree.part import Part

@ -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: `315`
This documentation is for API version: `339`
!!! 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/).

@ -24,7 +24,7 @@ Press on the server icon to navigate to the server selection view:
!!! success "Server Profiles"
The app supports multiple server profiles, providing simple switching between different InvenTree servers and/or account profiles.
Press the <span class='fas fa-plus-circle blue'></span> button in the bottom-right corner of the screen to create a new server profile.
Press the {{ icon("circle-plus", color="blue") }} button in the bottom-right corner of the screen to create a new server profile.
{% with id="add_profile", url="app/add_server_profile.png", maxheight="240px", description="Add server" %}
{% include 'img.html' %}
@ -45,7 +45,7 @@ Once the server profile is created, you need to connect to the server. Simply sh
Alternatively, long press on the server profile to activate the context menu, then select *Connect to Server*.
When the app successfully connects to the server, a success message is briefly displayed at the bottom of the screen. A green <span class='fas fa-check-circle green'></span> icon next to the server profile indicate that the profile is currently *selected* and also the connection was successful.
When the app successfully connects to the server, a success message is briefly displayed at the bottom of the screen. A green {{ icon("circle-check", color="green") }} icon next to the server profile indicate that the profile is currently *selected* and also the connection was successful.
{% with id="connected", url="app/connected.png", maxheight="240px", description="Connected to server" %}
{% include 'img.html' %}
@ -53,7 +53,7 @@ When the app successfully connects to the server, a success message is briefly d
### Connection Failure
If (for whatever reason) the app does not successfully connect to the InvenTree server, a failure message is displayed, and a red <span class='fas fa-times-circle red'></span> icon is displayed next to the server profile.
If (for whatever reason) the app does not successfully connect to the InvenTree server, a failure message is displayed, and a red {{ icon("circle-x", color="red") }} icon is displayed next to the server profile.
{% with id="failed", url="app/unauthorized.png", maxheight="240px", description="Connection failure" %}
{% include 'img.html' %}

@ -8,7 +8,7 @@ title: InvenTree Mobile App
-----
The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../api/api.md), the app provides immediate access to inventory data without requiring physical access to a computer.
The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../api/index.md), the app provides immediate access to inventory data without requiring physical access to a computer.
Native barcode support provides a multitude of context-sensitive stock control actions, allowing streamlined inventory management at your fingertips. The app has been optimized for speed, providing instant access to stock knowledge and handy on-site functionality.

@ -31,7 +31,7 @@ The *Global Action* buttons are visible on most screens, displayed in the bottom
### Open Drawer Menu
The <span class='fas fa-list'></span> action opens the *Drawer Menu*, which is a quick-access menu for global navigation:
The {{ icon("list") }} action opens the *Drawer Menu*, which is a quick-access menu for global navigation:
{% with id="drawer", url="app/drawer.png", maxheight="240px", description="Open drawer menu" %}
{% include 'img.html' %}
@ -44,11 +44,11 @@ The *Drawer Menu* can be accessed in the following ways:
### Search
The <span class='fas fa-search'></span> action opens the [Search](./search.md) screen
The {{ icon("search", title="Search") }} action opens the [Search](./search.md) screen
### Scan Barcode
The <span class='fas fa-qrcode'></span> action opens the [barcode scan](./barcode.md#global-scan) window, which allows quick access to the barcode scanning functionality.
The {{ icon("barcode", title="Scan") }} action opens the [barcode scan](./barcode.md#global-scan) window, which allows quick access to the barcode scanning functionality.
## Context Actions

@ -152,7 +152,7 @@ This barcode can then be used to track the stock item.
#### Print Label
If the server supports [label printing plugins](../extend/plugins/label.md), then an option to print a label for the selected stock item:
If the server supports [label printing plugins](../plugins/mixins/label.md), then an option to print a label for the selected stock item:
{% with id="label_print_1", url="stock_print_label_1.png", description="Print label via plugin" %}
{% include 'app_img.html' %}

Binary file not shown.

Before

(image error) Size: 100 KiB

After

(image error) Size: 188 KiB

Binary file not shown.

Before

(image error) Size: 34 KiB

After

(image error) Size: 106 KiB

Binary file not shown.

Before

(image error) Size: 44 KiB

After

(image error) Size: 124 KiB

Binary file not shown.

Before

(image error) Size: 170 KiB

After

(image error) Size: 114 KiB

Binary file not shown.

Before

(image error) Size: 273 KiB

Binary file not shown.

Before

(image error) Size: 122 KiB

After

(image error) Size: 109 KiB

Binary file not shown.

Before

(image error) Size: 203 KiB

After

(image error) Size: 214 KiB

Binary file not shown.

Before

(image error) Size: 65 KiB

Binary file not shown.

Before

(image error) Size: 84 KiB

After

(image error) Size: 194 KiB

Binary file not shown.

Before

(image error) Size: 122 KiB

After

(image error) Size: 292 KiB

Binary file not shown.

Before

(image error) Size: 37 KiB

After

(image error) Size: 63 KiB

Binary file not shown.

Before

(image error) Size: 19 KiB

After

(image error) Size: 33 KiB

Binary file not shown.

Before

(image error) Size: 61 KiB

Binary file not shown.

Before

(image error) Size: 111 KiB

After

(image error) Size: 154 KiB

Binary file not shown.

Before

(image error) Size: 45 KiB

After

(image error) Size: 127 KiB

Binary file not shown.

Before

(image error) Size: 77 KiB

After

(image error) Size: 222 KiB

Binary file not shown.

Before

(image error) Size: 56 KiB

Binary file not shown.

Before

(image error) Size: 86 KiB

After

(image error) Size: 128 KiB

Binary file not shown.

Before

(image error) Size: 43 KiB

After

(image error) Size: 221 KiB

Binary file not shown.

Before

(image error) Size: 89 KiB

After

(image error) Size: 162 KiB

Binary file not shown.

Before

(image error) Size: 354 KiB

Binary file not shown.

Before

(image error) Size: 113 KiB

After

(image error) Size: 154 KiB

Binary file not shown.

Before

(image error) Size: 90 KiB

After

(image error) Size: 440 KiB

Binary file not shown.

Before

(image error) Size: 33 KiB

After

(image error) Size: 120 KiB

Binary file not shown.

Before

(image error) Size: 30 KiB

After

(image error) Size: 140 KiB

Binary file not shown.

Before

(image error) Size: 35 KiB

After

(image error) Size: 131 KiB

Binary file not shown.

Before

(image error) Size: 21 KiB

After

(image error) Size: 109 KiB

Binary file not shown.

Before

(image error) Size: 33 KiB

After

(image error) Size: 77 KiB

Binary file not shown.

Before

(image error) Size: 71 KiB

After

(image error) Size: 211 KiB

Binary file not shown.

Before

(image error) Size: 73 KiB

After

(image error) Size: 131 KiB

Binary file not shown.

Before

(image error) Size: 31 KiB

After

(image error) Size: 106 KiB

Binary file not shown.

Before

(image error) Size: 33 KiB

After

(image error) Size: 77 KiB

Binary file not shown.

Before

(image error) Size: 22 KiB

After

(image error) Size: 114 KiB

Binary file not shown.

Before

(image error) Size: 34 KiB

After

(image error) Size: 141 KiB

Binary file not shown.

Before

(image error) Size: 82 KiB

After

(image error) Size: 197 KiB

Binary file not shown.

Before

(image error) Size: 161 KiB

After

(image error) Size: 149 KiB

Binary file not shown.

Before

(image error) Size: 149 KiB

After

(image error) Size: 198 KiB

Binary file not shown.

Before

(image error) Size: 318 KiB

Binary file not shown.

Before

(image error) Size: 84 KiB

After

(image error) Size: 75 KiB

Binary file not shown.

Before

(image error) Size: 98 KiB

After

(image error) Size: 318 KiB

Binary file not shown.

Before

(image error) Size: 111 KiB

After

(image error) Size: 372 KiB

Binary file not shown.

Before

(image error) Size: 89 KiB

After

(image error) Size: 172 KiB

Binary file not shown.

Before

(image error) Size: 46 KiB

After

(image error) Size: 280 KiB

Binary file not shown.

Before

(image error) Size: 40 KiB

After

(image error) Size: 150 KiB

Binary file not shown.

Before

(image error) Size: 53 KiB

After

(image error) Size: 138 KiB

Binary file not shown.

Before

(image error) Size: 73 KiB

After

(image error) Size: 351 KiB

Binary file not shown.

Before

(image error) Size: 82 KiB

After

(image error) Size: 294 KiB

Binary file not shown.

Before

(image error) Size: 67 KiB

After

(image error) Size: 243 KiB

Binary file not shown.

Before

(image error) Size: 49 KiB

After

(image error) Size: 135 KiB

Binary file not shown.

Before

(image error) Size: 69 KiB

After

(image error) Size: 94 KiB

Binary file not shown.

Before

(image error) Size: 41 KiB

After

(image error) Size: 132 KiB

Binary file not shown.

Before

(image error) Size: 85 KiB

After

(image error) Size: 210 KiB

Binary file not shown.

Before

(image error) Size: 32 KiB

After

(image error) Size: 217 KiB

Binary file not shown.

Before

(image error) Size: 130 KiB

After

(image error) Size: 114 KiB

Binary file not shown.

Before

(image error) Size: 15 KiB

After

(image error) Size: 140 KiB

Binary file not shown.

Before

(image error) Size: 31 KiB

Binary file not shown.

Before

(image error) Size: 65 KiB

After

(image error) Size: 118 KiB

Binary file not shown.

Before

(image error) Size: 192 KiB

After

(image error) Size: 89 KiB

Binary file not shown.

Before

(image error) Size: 20 KiB

After

(image error) Size: 72 KiB

Binary file not shown.

Before

(image error) Size: 194 KiB

After

(image error) Size: 225 KiB

Binary file not shown.

Before

(image error) Size: 142 KiB

After

(image error) Size: 169 KiB

Binary file not shown.

Before

(image error) Size: 63 KiB

After

(image error) Size: 125 KiB

Binary file not shown.

Before

(image error) Size: 341 KiB

After

(image error) Size: 286 KiB

Binary file not shown.

Before

(image error) Size: 183 KiB

After

(image error) Size: 114 KiB

Binary file not shown.

Before

(image error) Size: 420 KiB

After

(image error) Size: 317 KiB

Binary file not shown.

Before

(image error) Size: 202 KiB

After

(image error) Size: 173 KiB

Binary file not shown.

Before

(image error) Size: 47 KiB

After

(image error) Size: 156 KiB

Binary file not shown.

Before

(image error) Size: 175 KiB

After

(image error) Size: 200 KiB

Binary file not shown.

Before

(image error) Size: 29 KiB

After

(image error) Size: 76 KiB

Binary file not shown.

Before

(image error) Size: 139 KiB

After

(image error) Size: 176 KiB

Binary file not shown.

Before

(image error) Size: 35 KiB

Binary file not shown.

Before

(image error) Size: 12 KiB

Binary file not shown.

Before

(image error) Size: 3.0 KiB

Binary file not shown.

Before

(image error) Size: 33 KiB

After

(image error) Size: 56 KiB

Binary file not shown.

Before

(image error) Size: 74 KiB

After

(image error) Size: 105 KiB

Binary file not shown.

Before

(image error) Size: 5.9 KiB

Binary file not shown.

Before

(image error) Size: 72 KiB

After

(image error) Size: 187 KiB

Binary file not shown.

Before

(image error) Size: 26 KiB

After

(image error) Size: 83 KiB

Binary file not shown.

Before

(image error) Size: 80 KiB

After

(image error) Size: 87 KiB

Binary file not shown.

Before

(image error) Size: 44 KiB

After

(image error) Size: 229 KiB

Binary file not shown.

Before

(image error) Size: 14 KiB

After

(image error) Size: 69 KiB

Binary file not shown.

Before

(image error) Size: 70 KiB

After

(image error) Size: 225 KiB

Binary file not shown.

Before

(image error) Size: 34 KiB

After

(image error) Size: 98 KiB

Binary file not shown.

Before

(image error) Size: 128 KiB

After

(image error) Size: 176 KiB

Binary file not shown.

Before

(image error) Size: 92 KiB

After

(image error) Size: 83 KiB

Some files were not shown because too many files have changed in this diff Show More