2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-10-30 04:35:42 +00:00

[docs] Docs updates (#10678)

* Display PendingShipments panel

- Overview of all outstanding shipments

* Update UI tests

* add separate page for troubleshooting

* Restructure menus a bit

* Fix top-level page for mobile app

* Add option to override default value in docs

* Update global.md

* Formatting updates

* Update sales pages

* Move order images to "purchasing"

* Small tweaks

* Make "Concepts" a top-level documentation item

* Update image
This commit is contained in:
Oliver
2025-10-26 17:16:59 +11:00
committed by GitHub
parent c54f3f4a30
commit 1f438bb734
56 changed files with 272 additions and 217 deletions

View File

@@ -318,17 +318,20 @@ def define_env(env):
json.dump(data, f, indent=4)
@env.macro
def rendersetting(key: str, setting: dict, short: bool = False):
def rendersetting(
key: str, setting: dict, short: bool = False, default: Optional[str] = None
):
"""Render a provided setting object into a table row.
Arguments:
key: The name of the setting to extract information for.
setting: The setting object to render.
short: If True, return a short version of the setting (default: False)
default: An optional default value to override the setting's default display value.
"""
name = setting['name']
description = setting['description']
default = setting.get('default')
default = default or setting.get('default')
units = setting.get('units')
default = f'`{default}`' if default else ''
@@ -340,12 +343,13 @@ def define_env(env):
return f'| <div title="{key}"><strong>{name}</strong></div> | {description} | {default} | {units} |'
@env.macro
def globalsetting(key: str, short: bool = False):
def globalsetting(key: str, short: bool = False, default: Optional[str] = None):
"""Extract information on a particular global setting.
Arguments:
key: The name of the global setting to extract information for.
short: If True, return a short version of the setting (default: False)
default: An optional default value to override the setting's default display value.
"""
global GLOBAL_SETTINGS
setting = GLOBAL_SETTINGS[key]
@@ -354,7 +358,7 @@ def define_env(env):
if not short:
observe_setting(key, 'global')
return rendersetting(key, setting, short=short)
return rendersetting(key, setting, short=short, default=default)
@env.macro
def usersetting(key: str, short: bool = False):