Merge pull request #24 from eeintech/fix_start_config

Fix broken markdown on 'Getting Started/Configuration' page

docs/build/build.md

@@ -8,7 +8,7 @@ Build management can be accessed via the *Build* navigation tab.
 
 A "basic" build flow is as follow:
 
-1. create a part with the [*Assembly option*](/part/views/#part-options) turned-on
+1. create a part with the [*Assembly option*](../../part/views/#part-options) turned-on
 0. add a Bill of Material (BOM)
 0. create a "Build Order" for this part
 0. allocate stocks from your inventory
@@ -60,7 +60,7 @@ To allocate stock for a build, you have two options:
 1. **automatic** allocation: if each subpart has only **one** storage location, InvenTree can allocate stock from this location automatically
 0. **manual** allocation: user can define allocation for each subpart in the build.
 
-During allocation, InvenTree relies on [Stock items](/stock/stock/#stock-item) to reference parts that will be used for the build. Make sure to read through the [stock documentation](/stock/stock) before proceeding with stock allocation.
+During allocation, InvenTree relies on [Stock items](../../stock/stock/#stock-item) to reference parts that will be used for the build. Make sure to read through the [stock documentation](../../stock/stock) before proceeding with stock allocation.
 
 #### Automatic Allocation
 

docs/report/report.md

@@ -64,4 +64,4 @@ latex:
 
 ## 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). Only users with admin access can upload and/or edit report template files.

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) 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.
 

docs/start/config.md

@@ -27,14 +27,11 @@ InvenTree provides support for multiple database backends - any backend supporte
 
 Database options are specified under the *database* heading in the configuration file. Any option available in the Django documentation can be used here - it is passed through transparently to the management scripts.
 
-<hr>
+#### SQLite
+By default, InvenTree uses an sqlite database file : `inventree_db.sqlite3`. This provides a simple, portable database file that is easy to use for debug and testing purposes. 
 
-**SQLite:**
+#### MySQL
-By default, InvenTree uses an sqlite database file : ``inventree_db.sqlite3``. This provides a simple, portable database file that is easy to use for debug and testing purposes. 
+MySQL database backend is supported with the native Django implemetation. To run InvenTree with the MySQL backend, a number of extra packages need to be installed:
-
-<hr>
-
-**MySQL:** MySQL database backend is supported with the native Django implemetation. To run InvenTree with the MySQL backend, a number of extra packages need to be installed:
 
 * mysql-server - *MySQL backend server*
 * libmysqlclient-dev - *Required for connecting to the MySQL database in Python*
@@ -49,13 +46,12 @@ invoke mysql
 It is then up to the database adminstrator to create a new MySQL database to store inventree data, in addition to a username/password to access the data.
 
 !!! info "MySQL Collation"
-    When creating the MySQL database, the adminstrator must ensure that the collation option is set to <b>utf8_unicode_520_ci</b> to ensure that InvenTree features function correctly.
+    When creating the MySQL database, the adminstrator must ensure that the collation option is set to **utf8_unicode_520_ci** to ensure that InvenTree features function correctly.
 
 The database options (in the `config.yaml` file) then need to be adjusted to communicate the MySQL backend. Refer to the [Django docs](https://docs.djangoproject.com/en/dev/ref/databases/) for further information.
 
-<hr>
+#### PostgreSQL
-
+PostgreSQL database backend is supported with the native Django implementation. Note that to use this backend, the following system packages must be installed:
-**PostgreSQL:** PostgreSQL database backend is supported with the native Django implementation. Note that to use this backend, the following system packages must be installed:
 
 * postgresql
 * postgresql-contrib
@@ -70,7 +66,7 @@ invoke postgresql
 
 It is then up to the database adminstrator to create a new PostgreSQL database to store inventree data, in addition to a username/password to access the data.
 
-The database options (in the ``config.yaml`` file) then need to be adjusted to communicate the PostgreSQL backend. Refer to the [Django docs](https://docs.djangoproject.com/en/dev/ref/databases/) for further information.
+The database options (in the `config.yaml` file) then need to be adjusted to communicate the PostgreSQL backend. Refer to the [Django docs](https://docs.djangoproject.com/en/dev/ref/databases/) for further information.
 
 ### Allowed Hosts / CORS
 

mkdocs.yml

@@ -19,7 +19,7 @@ theme:
   icon:
     repo: fontawesome/brands/github
   features:
-    - tabs
+    - navigation.tabs
     - toc.autohide
 edit_uri: "" # Disable "Edit" button
 extra_css:

requirements.txt

@@ -8,7 +8,7 @@ Markdown>=3.2.2,<4.0
 MarkupSafe>=1.1.1,<2.0
 mkdocs>=1.1.2,<2.0
 mkdocs-macros-plugin>=0.4.9,<1.0
-mkdocs-material>=5.5.12,<6.0
+mkdocs-material>=6.1,<7.0
 mkdocs-material-extensions>=1.0,<2.0
 nltk>=3.5,<4.0
 Pygments>=2.7.1,<3.0