From 640d5852e479f411120c2ec876e7476d30bc8337 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Sun, 26 Jan 2025 11:00:14 +1100
Subject: [PATCH] Docs updates: (#8951)

* Docs updates:

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

* Revert config
---
 docs/docs/hooks.py |  4 ++--
 docs/main.py       | 15 ++++++++++-----
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/docs/docs/hooks.py b/docs/docs/hooks.py
index 574cafdfb02d..764068556489 100644
--- a/docs/docs/hooks.py
+++ b/docs/docs/hooks.py
@@ -161,8 +161,8 @@ def on_config(config, *args, **kwargs):
     #    fetch_rtd_versions()
 
     if rtd:
-        rtd_version = os.environ['READTHEDOCS_VERSION']
-        rtd_language = os.environ['READTHEDOCS_LANGUAGE']
+        rtd_version = os.environ.get('READTHEDOCS_VERSION')
+        rtd_language = os.environ.get('READTHEDOCS_LANGUAGE')
 
         site_url = f'https://docs.inventree.org/{rtd_language}/{rtd_version}'
         assets_dir = f'/{rtd_language}/{rtd_version}/assets'
diff --git a/docs/main.py b/docs/main.py
index cf93a4f33e74..19ead8d865e3 100644
--- a/docs/main.py
+++ b/docs/main.py
@@ -25,7 +25,7 @@
     'READTHEDOCS_VERSION_NAME',
     'READTHEDOCS_VERSION_TYPE',
 ]:
-    val = os.environ.get(key) or '-- MISSING --'
+    val = os.environ.get(key, None) or '-- MISSING --'
     print(f' - {key}: {val}')
 
 # Cached settings dict values
@@ -266,14 +266,19 @@ def templatefile(filename):
         return includefile(fn, f'Template: {base}', fmt='html')
 
     @env.macro
-    def rendersetting(setting: dict):
+    def rendersetting(key: str, setting: dict):
         """Render a provided setting object into a table row."""
         name = setting['name']
         description = setting['description']
         default = setting.get('default')
         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
     def globalsetting(key: str):
@@ -285,7 +290,7 @@ def globalsetting(key: str):
         global GLOBAL_SETTINGS
         setting = GLOBAL_SETTINGS[key]
 
-        return rendersetting(setting)
+        return rendersetting(key, setting)
 
     @env.macro
     def usersetting(key: str):
@@ -297,4 +302,4 @@ def usersetting(key: str):
         global USER_SETTINGS
         setting = USER_SETTINGS[key]
 
-        return rendersetting(setting)
+        return rendersetting(key, setting)