diff --git a/README.md b/README.md index ecd63b1..ec0b2fd 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,12 @@ Refer to the [reference documentation](https://squidfunk.github.io/mkdocs-materi Links to internal documentation pages **must** use relative pathing, otherwise the link will be broken by the readthedocs URL formatting. +Also, linking to an internal page must use the `.md` suffix! + For example, to link to the page `/part/views` from `/stock/stocktake`, the link must be formed as follows: ``` -Click [here](../../part/views) +Click [here](../part/views.md) ``` *Formatting the link as follows:* diff --git a/docs/admin/admin.md b/docs/admin/admin.md index 030def7..0a6e5b8 100644 --- a/docs/admin/admin.md +++ b/docs/admin/admin.md @@ -9,7 +9,7 @@ Users which have *staff* privileges have access to an Admin interface which prov !!! warning "Caution" Admin users should exercise extreme care when modifying data via the admin interface, as performing the wrong action may have unintended consequences! -The admin interface allows *staff* users the ability to directly view / add / edit / delete database entries according to their [user permissions](../permissions). +The admin interface allows *staff* users the ability to directly view / add / edit / delete database entries according to their [user permissions](./permissions.md). ### Access Admin Interface diff --git a/docs/admin/email.md b/docs/admin/email.md index 3d9d93e..0ce0a6a 100644 --- a/docs/admin/email.md +++ b/docs/admin/email.md @@ -6,7 +6,7 @@ title: Email Configured InvenTree can be configured to send emails to users, for various purposes. -To enable this, email configuration settings must be supplied to the InvenTree [configuration options](../../start/config#email-settings). +To enable this, email configuration settings must be supplied to the InvenTree [configuration options](../start/config.md#email-settings). !!! info "Password Reset" The *Password Reset* functionality requires the email backend to be correctly configured. diff --git a/docs/admin/import.md b/docs/admin/import.md index 9170617..8c1ad1b 100644 --- a/docs/admin/import.md +++ b/docs/admin/import.md @@ -31,7 +31,7 @@ Select the data file to import, and the data format. Press the "Submit" button t ### File Format -The uploaded data file must meet a number of formatting requirements for successful data upload. A simple way of ensuring that the file format is correct is to first [export data](../export) for the model in question, and delete all data rows (not the header row) from the exported data file. +The uploaded data file must meet a number of formatting requirements for successful data upload. A simple way of ensuring that the file format is correct is to first [export data](./export.md) for the model in question, and delete all data rows (not the header row) from the exported data file. Then, the same file can be used as a template for uploading more data to the server. diff --git a/docs/app/app.md b/docs/app/app.md index e0493dd..927fc46 100644 --- a/docs/app/app.md +++ b/docs/app/app.md @@ -4,7 +4,7 @@ title: InvenTree Mobile App ## InvenTree Mobile App -The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../../extend/api), 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](../extend/api.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. @@ -95,7 +95,7 @@ Select *InvenTree* to navigate to the [home screen](#home-screen). ### Scan Barcode -Select *Scan Barcode* to open the barcode scanner, and scan an InvenTree stock item or location to instantly jump to the relevent view. Refer to the [barcode documentation](./barcode) for more information. +Select *Scan Barcode* to open the barcode scanner, and scan an InvenTree stock item or location to instantly jump to the relevent view. Refer to the [barcode documentation](./barcode.md) for more information. ### Search @@ -103,15 +103,15 @@ Select *Search* to open a global search screen. ### Parts -Select *Parts* to navigate to the [Parts](./parts) view. +Select *Parts* to navigate to the [Parts](./part.md) view. ### Stock -Select *Stock* to navigate to the [Stock](./stock) view. +Select *Stock* to navigate to the [Stock](./stock.md) view. ### Settings -Select *Settings* to navigate to the app [settings](./settings) menu. +Select *Settings* to navigate to the app [settings](./settings.md) menu. ## Home Screen diff --git a/docs/build/allocate.md b/docs/build/allocate.md index 10e60f6..4ce944b 100644 --- a/docs/build/allocate.md +++ b/docs/build/allocate.md @@ -31,7 +31,7 @@ Before continuing, it is important that the difference between *untracked* and * #### BOM Considerations -A [Bill of Materials](../bom) to generate an assembly may consist of a mixture of *untracked* and *tracked* components. The build order process can facilitate this, as documentated in the sections below. +A [Bill of Materials](./bom.md) to generate an assembly may consist of a mixture of *untracked* and *tracked* components. The build order process can facilitate this, as documentated in the sections below. ### Tracked Build Outputs diff --git a/docs/build/bom.md b/docs/build/bom.md index 260ff45..c82bc42 100644 --- a/docs/build/bom.md +++ b/docs/build/bom.md @@ -4,7 +4,7 @@ title: Bill of Materials ## Bill of Materials -A Bill of Materials (BOM) defines the list of component parts required to make an assembly, [create builds](../build) and allocate inventory. +A Bill of Materials (BOM) defines the list of component parts required to make an assembly, [create builds](./build.md) and allocate inventory. A part which can be built from other sub components is called an *Assembly*. @@ -30,7 +30,7 @@ A BOM for a particular assembly is comprised of a number (zero or more) of BOM " ### Inherited BOM Line Items -When using the InvenTree [template / variant](../../part/template) feature, it may be useful to make use of the *inheritance* capability of BOM Line Items. +When using the InvenTree [template / variant](../part/template.md) feature, it may be useful to make use of the *inheritance* capability of BOM Line Items. If a BOM Line Item is designed as *Inherited*, it will be automatically included in the BOM of any part which is a variant (or sub-variant) of the part for which the BOM Line Item is defined. diff --git a/docs/build/build.md b/docs/build/build.md index 4a6fe50..4c7d32d 100644 --- a/docs/build/build.md +++ b/docs/build/build.md @@ -4,9 +4,9 @@ title: Build Orders ## Build Orders -A *Build Order* is used to create new stock by assembling component parts, according to a [Bill of Materials](../bom)(BOM). +A *Build Order* is used to create new stock by assembling component parts, according to a [Bill of Materials](./bom.md)(BOM). -A BOM can be specified for any [Part](../../part/part) which is designated as an *Assembly*. The BOM consists of other Parts which are designated as *Components*. +A BOM can be specified for any [Part](../part/part.md) which is designated as an *Assembly*. The BOM consists of other Parts which are designated as *Components*. A *Build Order* uses the BOM to allocate stock items to the assembly process. As the *Build Order* is completed, the required stock quantities are subtracted from allocated stock items. @@ -80,7 +80,7 @@ Allocating stock to a build does not actually subtrack the stock from the databa !!! info "Part Allocation Information" Any part which has stock allocated to a build order will indicate this on the part information page. -For further information, refer to the [stock allocation documentation](../allocate). +For further information, refer to the [stock allocation documentation](./allocate.md). ## Build Order Display diff --git a/docs/companies/customer.md b/docs/companies/customer.md index 8e10ac4..818bcf1 100644 --- a/docs/companies/customer.md +++ b/docs/companies/customer.md @@ -9,7 +9,7 @@ A customer is an external client to whom parts are sold. To access the customer page, click on the "Sell" navigation tab and click on "Customers" option in the dropdown list. !!! warning - **Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../../admin/permissions) + **Viewing**, **adding**, **editing** and **deleting** customers require the corresponding [Sales Orders user permissions](../admin/permissions.md) ### Add Customer diff --git a/docs/companies/manufacturer.md b/docs/companies/manufacturer.md index 42e2836..2979350 100644 --- a/docs/companies/manufacturer.md +++ b/docs/companies/manufacturer.md @@ -9,14 +9,14 @@ A manufacturer is an external **producer** of parts and raw materials. To access the manufacturer page, click on the "Buy" navigation tab and click on "Manufacturers" option in the dropdown list. !!! warning - **Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../../admin/permissions) + **Viewing**, **adding**, **editing** and **deleting** manufacturers require the corresponding [Purchase Orders user permissions](../admin/permissions.md) ### Add Manufacturer Once the manufacturer page is loaded, click on the " New Manufacturer" button: the "Create new Manufacturer" form opens. Fill-in the manufacturer informations (`Company name` and `Company description` are required) then click on the "Submit" button. !!! info "Manufacturer vs Supplier" - In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](../supplier#supplier-parts), therefore the manufacturer will need to be set as a supplier too. + In the case the manufacturer sells directly to customers, you may want to enable the checkbox `is supplier` before submitting the form (you can also enable it later on). Purchase orders rely exclusively on [supplier parts](./supplier.md#supplier-parts), therefore the manufacturer will need to be set as a supplier too. ### Edit Manufacturer @@ -38,7 +38,7 @@ After the manufacturer details are loaded, click on the ` tag. diff --git a/docs/report/labels.md b/docs/report/labels.md index 177345a..182088f 100644 --- a/docs/report/labels.md +++ b/docs/report/labels.md @@ -100,7 +100,7 @@ Location Name: {{ location.name }} ### Barcodes -Refer to the [barcode documentation](../barcodes). +Refer to the [barcode documentation](./barcodes.md). ### Conditional Formatting @@ -227,9 +227,9 @@ The following variables are made available to the StockItem label template: ### URL-style QR code -Stock Item labels support [QR code](../barcodes#qr-code) containing the stock item URL, which can be +Stock Item labels support [QR code](./barcodes.md#qr-code) containing the stock item URL, which can be scanned and opened directly -on a portable device using the camera or a QR code scanner. To generate a URL-style QR code for stock item in the [label HTML template](../labels#label-templates), add the +on a portable device using the camera or a QR code scanner. To generate a URL-style QR code for stock item in the [label HTML template](./labels.md#label-templates), add the following HTML tag: ``` html diff --git a/docs/report/report.md b/docs/report/report.md index 4d93ad2..9303817 100644 --- a/docs/report/report.md +++ b/docs/report/report.md @@ -103,7 +103,7 @@ Setting the *Debug Mode* option renders the template as raw HTML instead of PDF, ## Uploading Templates -Custom report templates can be uploaded using the [Admin Interface](../../admin/admin). Only users with admin access can upload and/or edit report template files. +Custom report templates can be uploaded using the [Admin Interface(../admin/admin.md). Only users with admin access can upload and/or edit report template files. ## Report Assets @@ -193,17 +193,17 @@ InvenTree supports the following reporting functionality: ### Test Report -[Test Report](../test): Format results of a test report against for a particular StockItem +[Test Report](./test.md): Format results of a test report against for a particular StockItem ### Packing List -[Packing List](../pack): Format a list of items for shipping or transfer +[Packing List](./pack.md): Format a list of items for shipping or transfer ### Build Report -[Build Order](../build): Format a build order report +[Build Order](./build.md): Format a build order report ### Purchase Order -[Purchase Order report](../order): Order line items +[Purchase Order report](./order.md): Order line items ### Sales Order Sales Order: TODO diff --git a/docs/report/test.md b/docs/report/test.md index 5b5a162..a3e3370 100644 --- a/docs/report/test.md +++ b/docs/report/test.md @@ -4,7 +4,7 @@ title: Test Report ## Test Report -InvenTree provides [test result](../../stock/test) tracking functionality which allows the users to keep track of any tests which have been performed on a given stock item. +InvenTree provides [test result](../stock/test.md) tracking functionality which allows the users to keep track of any tests which have been performed on a given stock item. Custom test reports may be generated against any given stock item. All testing data is made available to the template for custom rendering as required. diff --git a/docs/start/config.md b/docs/start/config.md index 2c4a68a..190bfa3 100644 --- a/docs/start/config.md +++ b/docs/start/config.md @@ -84,7 +84,7 @@ The following database options can be configured: ## Email Settings -To enable [email functionality](../../admin/email), email settings must be configured here, either via environment variables or within the configuration file. +To enable [email functionality](../admin/email.md), email settings must be configured here, either via environment variables or within the configuration file. The following email settings are available: diff --git a/docs/start/development.md b/docs/start/development.md index 2cf611e..c4ce785 100644 --- a/docs/start/development.md +++ b/docs/start/development.md @@ -5,12 +5,12 @@ title: Development Server ## Development Server !!! warning "Installation" - Before continuing, ensure that the [installation steps](../install) have been completed. + Before continuing, ensure that the [installation steps](./install.md) have been completed. InvenTree includes a simple server application, suitable for use in a development environment. !!! warning "Deployment" - Refer to the [production server instructions](../production) to implement a much more robust server setup. + Refer to the [production server instructions](./production.md) to implement a much more robust server setup. ### Running on a Local Machine diff --git a/docs/start/docker.md b/docs/start/docker.md index 278f75c..53eae8c 100644 --- a/docs/start/docker.md +++ b/docs/start/docker.md @@ -10,7 +10,7 @@ The InvenTree docker image contains all the required system packages, python mod ### Environment Variables -InvenTree run-time configuration options described in the [configuration documentation](../config) can be passed to the InvenTree container as environment variables. +InvenTree run-time configuration options described in the [configuration documentation](./config.md) can be passed to the InvenTree container as environment variables. The following environment variables for InvenTree server configuration are specified as part of the docker image, and can be overridden if required: @@ -46,7 +46,7 @@ Static files are stored internal to the container instance, at the location `/ho ### Configuration File -As discussed in the [configuration documentation](../config), InvenTree run-time settings can be provided in a configuration file. +As discussed in the [configuration documentation](./config.md), InvenTree run-time settings can be provided in a configuration file. By default, the docker container expects this configuration file in the location `/home/inventree/data/config.yaml`. If this file does not exist, it will be automatically created from a default template file. @@ -56,7 +56,7 @@ As this config file is inside the "data" directory (which should be mounted as a InvenTree uses a secret key to provide cryptographic signing for the application. -As specified in the [configuration documentation](../config/#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file. +As specified in the [configuration documentation](./config.md#secret-key) this can be passed to the InvenTree application directly as an environment variable, or provided via a file. By default, the InvenTree container expects the `INVENTREE_SECRET_KEY_FILE` to exist at `/home/inventree/data/secret_key.txt`. If this file does not exist, it will be created and a new key will be randomly generated. @@ -223,7 +223,7 @@ Alter (or add) environment variables into the docker-compose `environment` secti A configuration file `config.yaml` has been created in the data volume (at the location specified on your local disk). -Edit this file (as per the [configuration guidelines](../config)). +Edit this file (as per the [configuration guidelines](./config.md)). ### Run Web Server diff --git a/docs/start/install.md b/docs/start/install.md index 80b678c..6534a14 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -214,7 +214,7 @@ InvenTree configuration can be performed using environment variables, or the `co Edit the configuration file at `/home/inventree/src/InvenTree/config.yaml`. !!! info "Config Guidelines" - Refer to the [configuration guidelines](../config) for full details. + Refer to the [configuration guidelines](./config.md) for full details. !!! warning "Configure Database" Ensure database settings are correctly configured before proceeding to the next step! In particular, check that the database connection settings match the database you have created in the previous step. @@ -251,10 +251,10 @@ The InvenTree database is now setup and ready to run. A simple development serve The InvenTree development server is useful for testing and configuration - and it may be wholly sufficient for a small-scale installation. -Refer to the [development server instructions](../development) for further information. +Refer to the [development server instructions](./development.md) for further information. ### Production Server In a production environment, a more robust server setup is required. -Refer to the [production server instructions](../production) for further information. +Refer to the [production server instructions](./production.md) for further information. diff --git a/docs/start/intro.md b/docs/start/intro.md index f258744..ebaea15 100644 --- a/docs/start/intro.md +++ b/docs/start/intro.md @@ -31,11 +31,11 @@ The bulk of the InvenTree code base supports the custom web server application. The webserver code also provides a first-party API for performing database query actions. -Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](../deploy). +Once a database is setup, you need a way of accessing the data. InvenTree provides a "server" application out of the box, but this may not scale particularly well with multiple users. Instead, InvenTree can be served using a webserver such as [Gunicorn](https://gunicorn.org/). For more information see the [deployment documentation](./production.md). ### Background Tasks -A separate application handles management of [background tasks](../../admin/tasks), separate to user-facing web requests. +A separate application handles management of [background tasks](../admin/tasks.md), separate to user-facing web requests. ## OS Requirements @@ -123,7 +123,7 @@ There are multiple ways to get an InvenTree server up and running, of various co The recommended method of installing InvenTree is to use [docker](https://www.docker.com). InvenTree provides out-of-the-box support for docker and docker-compose, which provides a simple, reliable and repeatable pipeline for integration into your production environment. -Refer to the [docker setup instructions](../docker) for further information. +Refer to the [docker setup instructions](./docker.md) for further information. ### Bare Metal diff --git a/docs/start/migrate.md b/docs/start/migrate.md index 72217eb..e45a9d8 100644 --- a/docs/start/migrate.md +++ b/docs/start/migrate.md @@ -29,7 +29,7 @@ This will create JSON file at the specified location which contains all database ### Initialize New Database -Configure the new database using the normal processes (see [Configuration](../config)) +Configure the new database using the normal processes (see [Configuration](./config.md)) Then, ensure that the database schema are correctly initialized in the new database: diff --git a/docs/start/production.md b/docs/start/production.md index b3c4d20..1e72e57 100644 --- a/docs/start/production.md +++ b/docs/start/production.md @@ -5,7 +5,7 @@ title: Production Server ## Production Server !!! warning "Installation" - Before continuing, ensure that the [installation steps](../install) have been completed. + Before continuing, ensure that the [installation steps](./install.md) have been completed. The following instructions provide a reasonably performant server, using [gunicorn](https://gunicorn.org/) as a webserver, and [supervisor](http://supervisord.org/) as a process manager. diff --git a/docs/stock/owner.md b/docs/stock/owner.md index b37f68b..a940542 100644 --- a/docs/stock/owner.md +++ b/docs/stock/owner.md @@ -17,7 +17,7 @@ The stock ownership feature is disabled by default, and must be enabled via the ### Owner: Group vs User -There are two types of owners in InvenTree: [groups](../../admin/permissions/#group) and [users](../../admin/permissions/#user). +There are two types of owners in InvenTree: [groups](../admin/permissions.md#group) and [users](../admin/permissions.md#user). * If a group is selected as owner, **all** users linked to the specified group will be able to edit the stock location or item. * If a user is selected as owner, only the specified user will be able to edit the stock location or item. @@ -33,7 +33,7 @@ When selecting an owner, in the drop-down list, groups are annotated with the `( To specify the owner of a stock location, navigate to the stock location detail page. Click on the icon under the location's name then click on "Edit Location". !!! warning - If you cannot see the icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation](../../admin/permissions/#roles) and/or contact your InvenTree administrator. + If you cannot see the icon, it means that you do **not** have permissions to edit stock locations. Refer to [the permissions documentation/../admin/permissions.md#roles) and/or contact your InvenTree administrator. In the "Edit Stock Location" form, select the owner and click the "Submit" button: diff --git a/docs/stock/stock.md b/docs/stock/stock.md index 5f617d6..20874a1 100644 --- a/docs/stock/stock.md +++ b/docs/stock/stock.md @@ -8,7 +8,7 @@ A stock location represents a physical real-world location where *Stock Items* a ## Stock Item -A *Stock Item* is an actual instance of a [*Part*](../../part/part) item. It represents a physical quantity of the *Part* in a specific location. +A *Stock Item* is an actual instance of a [*Part*](../part/part.md) item. It represents a physical quantity of the *Part* in a specific location. ### Stock Item Details diff --git a/docs/stock/test.md b/docs/stock/test.md index 7afccd7..1de032d 100644 --- a/docs/stock/test.md +++ b/docs/stock/test.md @@ -6,7 +6,7 @@ title: Stock Test Result Stock items which are associated with a *trackable* part can have associated test data - this is particularly useful for tracking unit testing / commissioning / acceptance data against a serialized stock item. -The master "Part" record for the stock item can define multiple [test templates](../../part/test/), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item. +The master "Part" record for the stock item can define multiple [test templates](../part/test.md), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item. !!! missing "TODO" Include pictures of the Test Results tab @@ -44,7 +44,7 @@ Multiple results can be uploaded against the same test name. In cases where mult ### Automated Test Intgration -The stock item testing framework is especially useful when integrating with an automated acceptance testing framework. Test results can be uploaded using the [InvenTree API](../../extend/api/) or the [InvenTree Python Interface](../../extend/python/). +The stock item testing framework is especially useful when integrating with an automated acceptance testing framework. Test results can be uploaded using the [InvenTree API](../extend/api.md) or the [InvenTree Python Interface](../extend/python.md). !!! info "Example" You design and sell a temperature sensor which needs to be calibrated before it can be sold. An automated calibration tool sets the offset in the device, and uploads a test result to the InvenTree database.