reference docs

Author: FredHappyface

documentation/reference/README.md

@@ -6,5 +6,8 @@ A full list of `Nxtheme-creator` project modules.
 
 - [Nxtheme Creator](nxtheme_creator/index.md#nxtheme-creator)
     - [Module](nxtheme_creator/module.md#module)
+    - [Backends](nxtheme_creator/backends/index.md#backends)
+        - [Nxtheme](nxtheme_creator/backends/nxtheme.md#nxtheme)
+        - [Sarc Tool](nxtheme_creator/backends/sarc_tool.md#sarc-tool)
     - [Img Info](nxtheme_creator/img_info.md#img-info)
     - [Process Themes](nxtheme_creator/process_themes.md#process-themes)

documentation/reference/nxtheme_creator/backends/index.md

@@ -0,0 +1,13 @@
+# Backends
+
+[Nxtheme-creator Index](../../README.md#nxtheme-creator-index) / [Nxtheme Creator](../index.md#nxtheme-creator) / Backends
+
+> Auto-generated documentation for [nxtheme_creator.backends](../../../../nxtheme_creator/backends/__init__.py) module.
+
+- [Backends](#backends)
+  - [Modules](#modules)
+
+## Modules
+
+- [Nxtheme](./nxtheme.md)
+- [Sarc Tool](./sarc_tool.md)

documentation/reference/nxtheme_creator/backends/nxtheme.md

@@ -0,0 +1,38 @@
+# Nxtheme
+
+[Nxtheme-creator Index](../../README.md#nxtheme-creator-index) / [Nxtheme Creator](../index.md#nxtheme-creator) / [Backends](./index.md#backends) / Nxtheme
+
+> Auto-generated documentation for [nxtheme_creator.backends.nxtheme](../../../../nxtheme_creator/backends/nxtheme.py) module.
+
+- [Nxtheme](#nxtheme)
+  - [execute](#execute)
+
+## execute
+
+[Show source in nxtheme.py:7](../../../../nxtheme_creator/backends/nxtheme.py#L7)
+
+Use python subprocess to drive the user defined SwitchTheme.exe.
+
+#### Arguments
+
+- `nxthemebin` *str* - path to SwitchTheme.exe
+- `component_name` *str* - component to build. eg. home, apps etc
+- `image_path` *str* - path to the source image
+- `layout_path` *dict* - path to the layout file
+- `name` *str* - theme name
+- `author_name` *str* - author name
+- `out` *str* - destination file name
+
+#### Signature
+
+```python
+def execute(
+    nxthemebin: str,
+    component_name: str,
+    image_path: str,
+    layout_path: str,
+    theme_name: str,
+    author_name: str,
+    out: str,
+) -> None: ...
+```

documentation/reference/nxtheme_creator/backends/sarc_tool.md

@@ -0,0 +1,84 @@
+# Sarc Tool
+
+[Nxtheme-creator Index](../../README.md#nxtheme-creator-index) / [Nxtheme Creator](../index.md#nxtheme-creator) / [Backends](./index.md#backends) / Sarc Tool
+
+> Auto-generated documentation for [nxtheme_creator.backends.sarc_tool](../../../../nxtheme_creator/backends/sarc_tool.py) module.
+
+- [Sarc Tool](#sarc-tool)
+  - [clean_dict](#clean_dict)
+  - [dump_dict](#dump_dict)
+  - [execute](#execute)
+  - [sarc_create](#sarc_create)
+
+## clean_dict
+
+[Show source in sarc_tool.py:115](../../../../nxtheme_creator/backends/sarc_tool.py#L115)
+
+Recursively removes entries with None or 0 values from a dictionary, including
+nested dictionaries and lists.
+
+#### Signature
+
+```python
+def clean_dict(d: dict | list | typing.Any) -> dict | list | typing.Any: ...
+```
+
+
+
+## dump_dict
+
+[Show source in sarc_tool.py:104](../../../../nxtheme_creator/backends/sarc_tool.py#L104)
+
+Format the json files as similar to exelix11/SwitchThemeInjector as possible.
+
+known issues: elements like "X": 1E-05, are encoded as "X": 1e-05, this is
+reasonable per the json spec https://www.json.org/json-en.html. And has been
+confirmed as working with version 15
+
+#### Signature
+
+```python
+def dump_dict(json_data: dict) -> bytes: ...
+```
+
+
+
+## execute
+
+[Show source in sarc_tool.py:40](../../../../nxtheme_creator/backends/sarc_tool.py#L40)
+
+Python implementation of SwitchTheme.exe using the sarc lib to do a lot of the heavy lifting.
+
+#### Arguments
+
+- `component_name` *str* - component to build. eg. home, apps etc
+- `image_path` *str* - path to the source image
+- `layout_path` *dict* - path to the layout file
+- `name` *str* - theme name
+- `author_name` *str* - author name
+- `out` *str* - destination file name
+
+#### Signature
+
+```python
+def execute(
+    component_name: str,
+    image_path: str,
+    layout_path: str | None,
+    theme_name: str,
+    author_name: str,
+    out: str,
+) -> None: ...
+```
+
+
+
+## sarc_create
+
+[Show source in sarc_tool.py:27](../../../../nxtheme_creator/backends/sarc_tool.py#L27)
+
+#### Signature
+
+```python
+def sarc_create(files: dict[str, bytes], dest_file: str) -> None: ...
+```

documentation/reference/nxtheme_creator/img_info.md

@@ -10,22 +10,22 @@
 
 ## get_dds_info
 
-[Show source in img_info.py:30](../../../nxtheme_creator/img_info.py#L30)
+[Show source in img_info.py:32](../../../nxtheme_creator/img_info.py#L32)
 
 #### Signature
 
 ```python
-def get_dds_info(dds: bytes): ...
+def get_dds_info(dds: bytes) -> tuple[int, int, bool]: ...
 ```
 
 
 
 ## get_jpeg_info
 
-[Show source in img_info.py:6](../../../nxtheme_creator/img_info.py#L6)
+[Show source in img_info.py:8](../../../nxtheme_creator/img_info.py#L8)
 
 #### Signature
 
 ```python
-def get_jpeg_info(jpeg: bytes): ...
+def get_jpeg_info(jpeg: bytes) -> tuple[int, int, bool]: ...
 ```

documentation/reference/nxtheme_creator/index.md

@@ -25,5 +25,6 @@ def cli() -> None: ...
 ## Modules
 
 - [Module](./module.md)
+- [Backends](backends/index.md)
 - [Img Info](./img_info.md)
 - [Process Themes](./process_themes.md)