6f939931ca
* Update docker image - Move from alpine 3.19 to alpine 3.21 - Move from postgres13_client to postgres17_client * Update docker-compose file - Move from postgres:13 to postgres:16 - Move from redis:7.0 to redis:7-alpine * Update docs * Update docker docs * Separate Dockerfile for devcontainer - Debian based (python3.11-bookworm) - Install essential system packages * Instal postgres client * Further devcontainer updates - Bump postgresql image from 13 to 15 - Store psql data in the dev/psql directory - Install required frontend packages * Use --host mode for frontend server * Tweak devcontainer docs * Bump pre commit config file * Revert "Bump pre commit config file" This reverts commit bbfd875ac8ea682bb7e454e5ea349943a887b6f4.
InvenTree Documentation
This repository hosts the official documentation for InvenTree, an open source inventory management system.
To serve this documentation locally (e.g. for development), you will need to have Python 3 installed on your system.
Setup
Run the following commands from the top-level project directory:
$ git clone https://github.com/inventree/inventree
$ pip install --require-hashes -r docs/requirements.txt
Serve Locally
To serve the pages locally, run the following command (from the top-level project directory):
$ mkdocs serve -f docs/mkdocs.yml -a localhost:8080
Edit Documentation Files
Once the server is running, it will monitor the documentation files for any changes, and update the served pages.
Admonitions
"Admonition" blocks can be added as follow:
!!! info "This is the admonition block title"
This is the admonition block content
Refer to the reference documentation to customize the admonition block to the use-case (eg. warning, missing, info, etc.).
Internal Links
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.md)
Formatting the link as follows:
Click [here](/part/views)
will result in a broken link.
Images
Images are served from the ./docs/assets/images folder and can be added as follow:
{% with id="image_id", url="folder/image_name.png", description="Text shown if image is not loaded properly" %}
{% include 'img.html' %}
{% endwith %}
Replace:
image_idwith a short unique identifier for the image (most commonly,image_idis same asimage_name)folderwith the folder indocs/assets/imagesin which the image is storedimage_namewith the name of the image.pngwith the image extension (PNG or JPEG are preferred formats)
Global variables
Refer to the reference documentation to find out how to add global variables to the documentation site.
Global variables should be added in the # Global Variables section of the mkdocs.yml configuration file.
Credits
This documentation makes use of the mkdocs-material template