diff --git a/.gitignore b/.gitignore index a9acf9f..082bf82 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ # Ignore python environment files env-inv-doc/ -env/ \ No newline at end of file +env/ + +# Compiled python files +*.pyd +*.pyc \ No newline at end of file diff --git a/__pycache__/main.cpython-38.pyc b/__pycache__/main.cpython-38.pyc deleted file mode 100644 index 00b6e4b..0000000 Binary files a/__pycache__/main.cpython-38.pyc and /dev/null differ diff --git a/_includes/app_img.html b/_includes/app_img.html new file mode 100644 index 0000000..f6d67ca --- /dev/null +++ b/_includes/app_img.html @@ -0,0 +1,5 @@ +{% set url = 'app/' + url %} + +{% with id=id, url=url, maxheight="240px", description="" %} +{% include "img.html" %} +{% endwith %} \ No newline at end of file diff --git a/docs/app/barcode.md b/docs/app/barcode.md index d6996c2..2c2675e 100644 --- a/docs/app/barcode.md +++ b/docs/app/barcode.md @@ -27,5 +27,6 @@ The following code types are known to be supported ## Actions -!!! todo "TODO" - This section requires further work \ No newline at end of file +The InvenTree app uses barcodes where possible to provide efficient stock control operations. + +If there is a new barcode feature you would like to see, [let us know on GitHub](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aapp)! \ No newline at end of file diff --git a/docs/app/part.md b/docs/app/part.md index 67a7c67..9f672e9 100644 --- a/docs/app/part.md +++ b/docs/app/part.md @@ -2,37 +2,156 @@ title: Part Views --- -## InvenTree App Part Views +## Part Category View -!!! todo "TODO" - This section requires further work +From the *home screen*, select *Parts* to open the top-level part category view. -## Part +### Details Tab -!!! todo "TODO" - This section requires further work +The *Details* tab shows information about the selected part category. In particular, it shows the name and description of the category, a link to the parent category (if available) and a list of subcategories. -### Details +{% with id="part-category", url="part_category_detail.jpg" %} +{% include "app_img.html" %} +{% endwith %} -!!! todo "TODO" - This section requires further work +#### Parent Category -### Stock +If the current category has a parent category (i.e. it is not a top-level category) then a link is provided to the parent category. Tap the *parent category* tile to navigate to the category detail page for the parent category. -!!! todo "TODO" - This section requires further work +#### Subcategories -## Part Category +If the current category has any subcategories, these are listed here. Select any of the subcategories to navigate to it. -!!! todo "TODO" - This section requires further work +### Parts Tab -### Details +The *Parts* tab displays all the parts available in this category. Tap a displayed part to navigate to the part detail view. -!!! todo "TODO" - This section requires further work +{% with id="cat-parts", url="category_parts_tab.jpg" %} +{% include "app_img.html" %} +{% endwith %} -### Parts +The list of available parts can be filtered using the input box at the top of the screen: -!!! todo "TODO" - This section requires further work \ No newline at end of file +{% with id="cat-parts-filter", url="category_parts_filter.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +### Actions Tab + +The *Actions* tab displays the available actions for the selected category: + +{% with id="cat-actions", url="category_actions_tab.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +#### New Category + +Create a new subcategory under the current category: + +{% with id="cat-new-cat", url="new_category.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +#### New Part + +Create a new part within the current category: + +{% with id="cat-new-part", url="new_part.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +### Edit Category + +Select the *Edit* button in the top right corner of the screen to edit the details for the selected part category: + +{% with id="cat-edit", url="part_category_edit.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +!!! info "Permission Required" + If the user does not have permission to edit part details, this button will be hidden + +In the part category display screen, there are three tabs of information available: + +## Part Detail View + +The *Part Detail* view displays information about a single part: + +{% with id="part-details", url="part_details.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +### Details Tab + +The *details* tab shows information about the selected part. Some of the displayed tiles provide further information when selected: + +#### Category + +Tap on the displayed part category to navigate to a detail view for that category. + +#### Stock + +The *stock* tile shows the total quantity of stock available for the part. Tap on this tile to navigate to the *Stock Tab* view for this part. + +#### Notes + +Tap on the *notes* tile to view (and edit) the notes for this part: + +{% with id="part-notes", url="part_notes.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +#### Attachments + +Tap on the *attachments* tile to view the file attachments for this part: + +{% with id="part-attachments", url="part_attachments.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +New attachments can be uploaded by tapping on the icons in the top right of the screen. + +Select a particular attachment file to downloaded it to the local device. + +### Stock Tab + +The *Stock* tab displays all the stock items available for this part. Tap on a particular stock item to navigate to a detail view for that item. + +{% with id="part-stock", url="part_stock.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +The list of available stock items can be filtered using the input box at the top of the screen. + +### Actions Tab + +The *Actions* tab displays the available actions for the selected part: + +#### New Stock Item + +Create a new stock item for this part: + +{% with id="part-stock-new", url="new_stock_item.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +### Edit Part + +To edit the part details, select the *Edit* button in the top right corner of the screen: + +{% with id="part-edit", url="part_edit.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +!!! info "Permission Required" + If the user does not have permission to edit part details, this button will be hidden + +### Part Image View + +Tap the image of the part (displayed at the top left of the screen) to launch the part image view: + +{% with id="part-image", url="part_image.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +A full-screen view of the image is displayed. The user can also upload a new image for the part, either selecting an image from the device, or taking a new picture with the device's camera. diff --git a/docs/app/stock.md b/docs/app/stock.md index d49f7a9..d3017d6 100644 --- a/docs/app/stock.md +++ b/docs/app/stock.md @@ -2,21 +2,142 @@ title: Stock Views --- -## InvenTree App Stock Views +## Stock Location View -!!! todo "TODO" - This section requires further work +From the *home screen*, select *Stock* to open the top-level stock location view. -## Stock Item +### Details Tab -### Details +The *Details* tab shows information about the selected stock location. -### Actions +{% with id="loc-detail", url="location_detail.jpg" %} +{% include "app_img.html" %} +{% endwith %} -## Stock Location +#### Parent Location -### Details +If the current location has a parent location (i.e. it is not a top-level location) then a link is provided to the parent location. Tap the *parent location* tile to navigate to the location detail page for the parent location. -### Actions +#### Sublocations -## Search \ No newline at end of file +If the current stock location has any sublocations, they are listed here. Select any of the displayed sublocations to navigate to the detail view. + +### Stock Tab + +The *Stock* tab displays all the stock items available in this location. Tap a displayed stock item to navigate to the stock item detail view. + +{% with id="loc-stock", url="location_stock.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +The list of available stock items can be filtered using the input box at the top of the screen: + +{% with id="loc-filter", url="location_stock_filter.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +### Actions Tab + +The *Actions* tab displays the available actions for the selected location: + +{% with id="loc-actions", url="location_actions.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### New Location + +Create a new location under the current location: + +{% with id="loc-new", url="new_location.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### New Stock Item + +Create a new stock item in the current location: + +{% with id="loc-new-stock", url="new_stock_item_from_location.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +#### Scan Stock Items Into Location + +Use the barcode scanner to scan a stock item into the current location. + + +## Stock Item Detail View + +The *Stock Item Detail* view displays information about a single stock item: + +{% with id="stock-detail", url="stock_detail.jpg" %} +{% include "app_img.html" %} +{% endwith %} + + +### Details Tab + +The *details* tab shows information about the selected stock item. Some of the displayed tiles provide further information when selected: + +#### Part Tile + +Part information is displayed at the top of the screen. Tap on this tile to navigate to the detail view for the linked part + +#### Location + +Tap on the location tile to navigate to the location detail view + +#### Notes + +Tap on the notes tile to display and edit the notes for this stock item + +### Actions Tab + +The *actions* tab displays the available actions for the selected stock item: + +{% with id="stock-actions", url="stock_actions.jpg" %} +{% include "app_img.html" %} +{% endwith %} + +#### Count Stock + +Select the *Count Stock* action to validate the current number of items in stock. Use this option to perform a quick stocktake! + +!!! info "Serialized Stock" + The *count stock* action is not available for serialized stock items, as they have a fixed quantity of 1 + +#### Remove Stock + +Select this action to remove a certain quantity from the selected stock item. For example, if there are 12 items available, and you take 3 items, the listed quantity will be reduced to 9 itemes. + +#### Add Stock + +Select this action to add a certain quantity to the selected stock item. For example, if there are 12 items available, and you add 3 items, the listed quantity will be increased to 15 items. + +#### Transfer Stock + +Transfer (move) the stock item to a new location + +#### Scan Into Location + +Transfer the stock item into a new location by scanning the barcode for that location. If a *valid* stock location barcode is scanned, the stock item will be automatically relocated to that location + +#### Assign Barcode + +If a stock item has a third-party barcode (i.e. it has been received from a supplier with a barcode already printed) then this barcode can be used to track the stock item in InvenTree. + +Select the *assign barcode* action to scan this third-party barcode and assign it to this stock item. + +This barcode can then be used to track the stock item. + +### Edit Stock Item + +To edit the stock item details, select the *Edit* button in the top right corner of the screen: + +{% with id="stock-edit", url="stock_edit.jpg" %} +{% include "app_img.html" %} +{% endwith %} \ No newline at end of file diff --git a/docs/app/translation.md b/docs/app/translation.md index b3d8b7a..fc51d37 100644 --- a/docs/app/translation.md +++ b/docs/app/translation.md @@ -4,7 +4,7 @@ title: App Translations ## Translation Support -The InvenTree app, much like the InvenTree web-based application, is designed to support multiple language translations. +The InvenTree app is designed to support multiple language translations. As with the web application, translations are community contributed - if the app does not support your native language, contributions are very welcome! diff --git a/docs/assets/images/app/category_actions_tab.jpg b/docs/assets/images/app/category_actions_tab.jpg new file mode 100644 index 0000000..ab29f8f Binary files /dev/null and b/docs/assets/images/app/category_actions_tab.jpg differ diff --git a/docs/assets/images/app/category_parts_filter.jpg b/docs/assets/images/app/category_parts_filter.jpg new file mode 100644 index 0000000..dbba2cb Binary files /dev/null and b/docs/assets/images/app/category_parts_filter.jpg differ diff --git a/docs/assets/images/app/category_parts_tab.jpg b/docs/assets/images/app/category_parts_tab.jpg new file mode 100644 index 0000000..9ab2e59 Binary files /dev/null and b/docs/assets/images/app/category_parts_tab.jpg differ diff --git a/docs/assets/images/app/location_actions.jpg b/docs/assets/images/app/location_actions.jpg new file mode 100644 index 0000000..3b79aed Binary files /dev/null and b/docs/assets/images/app/location_actions.jpg differ diff --git a/docs/assets/images/app/location_detail.jpg b/docs/assets/images/app/location_detail.jpg new file mode 100644 index 0000000..ff4d917 Binary files /dev/null and b/docs/assets/images/app/location_detail.jpg differ diff --git a/docs/assets/images/app/location_stock.jpg b/docs/assets/images/app/location_stock.jpg new file mode 100644 index 0000000..e5f1efa Binary files /dev/null and b/docs/assets/images/app/location_stock.jpg differ diff --git a/docs/assets/images/app/location_stock_filter.jpg b/docs/assets/images/app/location_stock_filter.jpg new file mode 100644 index 0000000..98a91f4 Binary files /dev/null and b/docs/assets/images/app/location_stock_filter.jpg differ diff --git a/docs/assets/images/app/new_category.jpg b/docs/assets/images/app/new_category.jpg new file mode 100644 index 0000000..27dcd8f Binary files /dev/null and b/docs/assets/images/app/new_category.jpg differ diff --git a/docs/assets/images/app/new_location.jpg b/docs/assets/images/app/new_location.jpg new file mode 100644 index 0000000..cee3a89 Binary files /dev/null and b/docs/assets/images/app/new_location.jpg differ diff --git a/docs/assets/images/app/new_part.jpg b/docs/assets/images/app/new_part.jpg new file mode 100644 index 0000000..fa6935d Binary files /dev/null and b/docs/assets/images/app/new_part.jpg differ diff --git a/docs/assets/images/app/new_stock_item.jpg b/docs/assets/images/app/new_stock_item.jpg new file mode 100644 index 0000000..5dfe1b2 Binary files /dev/null and b/docs/assets/images/app/new_stock_item.jpg differ diff --git a/docs/assets/images/app/new_stock_item_from_location.jpg b/docs/assets/images/app/new_stock_item_from_location.jpg new file mode 100644 index 0000000..52aac3d Binary files /dev/null and b/docs/assets/images/app/new_stock_item_from_location.jpg differ diff --git a/docs/assets/images/app/part_attachments.jpg b/docs/assets/images/app/part_attachments.jpg new file mode 100644 index 0000000..0db36a3 Binary files /dev/null and b/docs/assets/images/app/part_attachments.jpg differ diff --git a/docs/assets/images/app/part_category_detail.jpg b/docs/assets/images/app/part_category_detail.jpg new file mode 100644 index 0000000..7b0c67a Binary files /dev/null and b/docs/assets/images/app/part_category_detail.jpg differ diff --git a/docs/assets/images/app/part_category_edit.jpg b/docs/assets/images/app/part_category_edit.jpg new file mode 100644 index 0000000..c07a880 Binary files /dev/null and b/docs/assets/images/app/part_category_edit.jpg differ diff --git a/docs/assets/images/app/part_details.jpg b/docs/assets/images/app/part_details.jpg new file mode 100644 index 0000000..b81586b Binary files /dev/null and b/docs/assets/images/app/part_details.jpg differ diff --git a/docs/assets/images/app/part_edit.jpg b/docs/assets/images/app/part_edit.jpg new file mode 100644 index 0000000..4df2940 Binary files /dev/null and b/docs/assets/images/app/part_edit.jpg differ diff --git a/docs/assets/images/app/part_image.jpg b/docs/assets/images/app/part_image.jpg new file mode 100644 index 0000000..bb36d2e Binary files /dev/null and b/docs/assets/images/app/part_image.jpg differ diff --git a/docs/assets/images/app/part_notes.jpg b/docs/assets/images/app/part_notes.jpg new file mode 100644 index 0000000..1007c5a Binary files /dev/null and b/docs/assets/images/app/part_notes.jpg differ diff --git a/docs/assets/images/app/part_stock.jpg b/docs/assets/images/app/part_stock.jpg new file mode 100644 index 0000000..b670327 Binary files /dev/null and b/docs/assets/images/app/part_stock.jpg differ diff --git a/docs/assets/images/app/stock_actions.jpg b/docs/assets/images/app/stock_actions.jpg new file mode 100644 index 0000000..aca383b Binary files /dev/null and b/docs/assets/images/app/stock_actions.jpg differ diff --git a/docs/assets/images/app/stock_detail.jpg b/docs/assets/images/app/stock_detail.jpg new file mode 100644 index 0000000..d0f8bd3 Binary files /dev/null and b/docs/assets/images/app/stock_detail.jpg differ diff --git a/docs/assets/images/app/stock_edit.jpg b/docs/assets/images/app/stock_edit.jpg new file mode 100644 index 0000000..39f0ca2 Binary files /dev/null and b/docs/assets/images/app/stock_edit.jpg differ