inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-28 03:26:45 +00:00
Code

Docs updates: (#8951) (#8953)

Browse Source 
* Docs updates:

- Fix error related to key access
- Fix rendering of settings tables
- Add setting key as mouseover text

* Revert config

(cherry picked from commit 640d5852e479f411120c2ec876e7476d30bc8337)

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
This commit is contained in:
github-actions[bot] 2025-01-26 11:26:23 +11:00 committed by GitHub
parent 4a3035ec85
commit abddfb0b04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/hooks.py
View File

@ -160,8 +160,8 @@ def on_config(config, *args, **kwargs):
# fetch_rtd_versions() # fetch_rtd_versions()
if rtd: if rtd:
rtd_version = os.environ['READTHEDOCS_VERSION'] rtd_version = os.environ.get('READTHEDOCS_VERSION')
rtd_language = os.environ['READTHEDOCS_LANGUAGE'] rtd_language = os.environ.get('READTHEDOCS_LANGUAGE')
site_url = f'https://docs.inventree.org/{rtd_language}/{rtd_version}' site_url = f'https://docs.inventree.org/{rtd_language}/{rtd_version}'
assets_dir = f'/{rtd_language}/{rtd_version}/assets' assets_dir = f'/{rtd_language}/{rtd_version}/assets'

15
docs/main.py
View File

@ -25,7 +25,7 @@ for key in [
'READTHEDOCS_VERSION_NAME', 'READTHEDOCS_VERSION_NAME',
'READTHEDOCS_VERSION_TYPE', 'READTHEDOCS_VERSION_TYPE',
]: ]:
val = os.environ.get(key) or '-- MISSING --' val = os.environ.get(key, None) or '-- MISSING --'
print(f' - {key}: {val}') print(f' - {key}: {val}')
# Cached settings dict values # Cached settings dict values
@ -266,14 +266,19 @@ def define_env(env):
return includefile(fn, f'Template: {base}', fmt='html') return includefile(fn, f'Template: {base}', fmt='html')
@env.macro @env.macro
def rendersetting(setting: dict): def rendersetting(key: str, setting: dict):
"""Render a provided setting object into a table row.""" """Render a provided setting object into a table row."""
name = setting['name'] name = setting['name']
description = setting['description'] description = setting['description']
default = setting.get('default') default = setting.get('default')
units = setting.get('units') units = setting.get('units')
return f'| {name} | {description} | {default if default is not None else ""} | {units if units is not None else ""} |' default = f'`{default}`' if default else ''
units = f'`{units}`' if units else ''
return (
f'| <div title="{key}">{name}</div> | {description} | {default} | {units} |'
)
@env.macro @env.macro
def globalsetting(key: str): def globalsetting(key: str):
@ -285,7 +290,7 @@ def define_env(env):
global GLOBAL_SETTINGS global GLOBAL_SETTINGS
setting = GLOBAL_SETTINGS[key] setting = GLOBAL_SETTINGS[key]
return rendersetting(setting) return rendersetting(key, setting)
@env.macro @env.macro
def usersetting(key: str): def usersetting(key: str):
@ -297,4 +302,4 @@ def define_env(env):
global USER_SETTINGS global USER_SETTINGS
setting = USER_SETTINGS[key] setting = USER_SETTINGS[key]
return rendersetting(setting) return rendersetting(key, setting)