From 0e51d8077a94ee66c4d676715349cc930683789a Mon Sep 17 00:00:00 2001 From: eeintech Date: Wed, 14 Oct 2020 10:40:31 -0500 Subject: [PATCH 1/2] Fixed broken documentation links --- docs/index.md | 16 ++++++++-------- docs/start/install.md | 6 +++--- docs/start/migrate.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/index.md b/docs/index.md index 71a4154..98ef9da 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,44 +20,44 @@ InvenTree is designed to allow for a flexible installation. You could run the In Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. -[Read more...](part/part) +[Read more...](/part/part) ### Manage Suppliers InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory. -[Read more...](buy/supplier) +[Read more...](/buy/supplier) ### Instant Stock Knowledge Instantly view current stock for a certain part, in a particular location, or required for an individual build. Stock items are organized in cascading locations and sub-locations, allowing flexible inspection of stock under any location. Stock items can be serialized for tracking of individual items, and test results can be stored against a serialized stock item for the purpose of acceptance testing and commissioning. -[Read more...](stock/stock) +[Read more...](/stock/stock) ### BOM Management Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part. InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database. -[Read more...](build/bom) +[Read more...](/build/bom) ### Build Parts Inventree features a build management system to help you track the progress of your builds. Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory. -[Read more...](build/build) +[Read more...](/build/build) ### Report -Generate a wide range of reports using custom templates. [Read more...](docs/report/report) +Generate a wide range of reports using custom templates. [Read more...](/report/report) ### Extend and Customize InvenTree is designed to be highly extensible. If the core InvenTree functionality does not meet your particular need, InvenTree provides a RESTful API, a native Python library, and a powerful plugin system. -[Read more...](extend/api) +[Read more...](/extend/api) ## Getting Started -Refer to the [installation guide](start/install) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed. \ No newline at end of file +Refer to the [installation guide](/start/install) for instructions on installing InvenTree. The server where InvenTree is to be installed will need to meet some basic package requirements, and a certain level of system administration understanding is assumed. \ No newline at end of file diff --git a/docs/start/install.md b/docs/start/install.md index b7e55ff..eb6617d 100644 --- a/docs/start/install.md +++ b/docs/start/install.md @@ -20,7 +20,7 @@ Database selection should be determined by your particular installation requirem ### Serving Data -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](start/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](/start/deploy). ## Setup @@ -122,7 +122,7 @@ Once the required packages are installed, the database configuration must be adj As part of the previous *install* step, a configuration file (**config.yaml**) is created. The configuration file provides administrators control over various setup options without digging into the Django *settings.py* script. The default setup uses a local sqlite database with *DEBUG* mode enabled. -For further information on installation configuration, refer to the [Configuration](start/config) section. +For further information on installation configuration, refer to the [Configuration](/start/config) section. !!! warning "Configure Database" Ensure database settings are correctly configured in `config.yaml` before proceeding to the next step! @@ -167,4 +167,4 @@ This will launch the InvenTree web interface at `http://127.0.0.1:8000`. For oth ### Run Production Server -For a production install, refer to [deployment instructions](start/deploy). +For a production install, refer to [deployment instructions](/start/deploy). diff --git a/docs/start/migrate.md b/docs/start/migrate.md index f4d39ee..7cd3faa 100644 --- a/docs/start/migrate.md +++ b/docs/start/migrate.md @@ -19,7 +19,7 @@ This will export all data (including user information) to a json data file. ### Initialize New Database -Configure the new database using the normal processes (see [Configuration](start/config)) +Configure the new database using the normal processes (see [Configuration](/start/config)) Then, ensure that the database schema are correctly initialized in the new database: From 4c04a75fe86022ac6a0e69bffe6b9916e51bdc84 Mon Sep 17 00:00:00 2001 From: eeintech Date: Wed, 14 Oct 2020 10:49:12 -0500 Subject: [PATCH 2/2] Fixed Paypal logo --- docs/contribute.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/contribute.md b/docs/contribute.md index 055eaaf..0a3318f 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -31,8 +31,13 @@ Documenting a large software project is a challenging and ongoing effort. If you ### Donate +{% if 'readthedocs.org' in config.docs_dir %} +{% set assets = '/en/latest/assets' %} +{% else %} +{% set assets = '/assets' %} +{% endif %} + If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development. -[ Donate :material-emoticon-cool: ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE¤cy_code=AUD){: .md-button .md-button--primary } -PayPal Logo - +[ Donate ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE¤cy_code=AUD){: .md-button .md-button--primary } +PayPal Logo