4b71130ebe
* Provide mechanism for config to override global settings * Ensure overrides are observed on save * Refactor * Add "read_only" field to serializer * Prevent editing for read_only settings * Bump API version * Update docs * Secure logs * Override applies to default_value * override get_setting method * Add unit test * Utilize new approach to override SITE_URL * Docs updates * Docs tweaks * Shortcut for get_global_setting * Remove previous change - Allow validation to be performed within the InvenTreeSetting class * Override INVENTREE_BASE_URL setting * Handle error on worker boot * Tweak unit test
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 follows:
{{ image("image_name.png", base="subfolder", title="Image title") }}
See the image macro in ./docs/main.py for more information.
Icons
Icons can be rendered (using the tabler icon set) as follows:
{{ icon("brand-github", color="red")}}
See the icon macro in ./docs/main.py for more information.
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