mirror of
https://github.com/inventree/InvenTree.git
synced 2025-06-15 03:25:42 +00:00
11ab0203b1
* Add builtin plugin for auto-issuing orders * Add plugin to auto-issue orders * Add placeholder documentation * Fix typo * Adds image macro - To replace img.html - includes checking if file exists * Fix tooltips * More docs * Adjust plugin settings filters * docs * More docs * More docs * Updates * Less restrictive URL checking * Refactor build order page * Fix typo * Allow 429 * Debug output * More debug * Construct assets dir * Cleanup * Update docs README * Refactoring more pages * Fix image link * Fix SSO settings * Add hook to check for missing settings - Ensure that all settings are documented! * Add missing user settings * Update docstring * Tweak SSO.md * Image updates * More updates * Tweaks * Exclude orders without a target_date * Fix for issuing build orders * Further refactoring * Fixes * Image refactoring * More refactoring * More refactoring * Refactor app images * Fix pathing issues * Suppress some openapidocs warnings in logs (much easier to debug docs build issues) * Fix image reference * Reduce error messages * Fix image links * Fix image links * Reduce docs log output * Ensure settings are loaded before displaying them * Fix for UI test * Fix unit test * Test tweaks
90 lines
2.7 KiB
Markdown
90 lines
2.7 KiB
Markdown
# InvenTree Documentation
|
|
|
|
[](https://inventree.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
This repository hosts the [official documentation](https://inventree.readthedocs.io/) for [InvenTree](https://github.com/inventree/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](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) 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](https://tabler.io/icons)) 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](https://squidfunk.github.io/mkdocs-material/reference/variables/#using-custom-variables) 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](https://github.com/squidfunk/mkdocs-material)
|