update documentation/reference

Author: FredHappyface

documentation/reference/MODULES.md

@@ -1,10 +1,9 @@
-# Layeredimage Modules
+# Layeredimage Index
 
-> Auto-generated documentation modules index.
+> Auto-generated documentation index.
 
-Full list of [Layeredimage](README.md#layeredimage-index) project modules.
+A full list of `Layeredimage` project modules.
 
-- [Layeredimage Index](README.md#layeredimage-index)
 - [Layeredimage](layeredimage/index.md#layeredimage)
     - [Blend](layeredimage/blend.md#blend)
     - [Io](layeredimage/io/index.md#io)

documentation/reference/README.md

@@ -1,7 +1,9 @@
 # Blend
 
-> Auto-generated documentation for [layeredimage.blend](../../../layeredimage/blend.py) module.
+[Layeredimage Index](../README.md#layeredimage-index) /
+[Layeredimage](./index.md#layeredimage) /
+Blend
 
-Provide blending functions with blendmodes...
+> Auto-generated documentation for [layeredimage.blend](../../../layeredimage/blend.py) module.
 
-- [Layeredimage](../README.md#layeredimage-index) / [Modules](../MODULES.md#layeredimage-modules) / [Layeredimage](index.md#layeredimage) / Blend
+- [Blend](#blend)

documentation/reference/layeredimage/blend.md

@@ -1,12 +1,16 @@
 # Layeredimage
 
+[Layeredimage Index](../README.md#layeredimage-index) /
+Layeredimage
+
 > Auto-generated documentation for [layeredimage](../../../layeredimage/__init__.py) module.
 
-Use this module to read, and write to a number of layered image formats.
+- [Layeredimage](#layeredimage)
+  - [Modules](#modules)
+
+## Modules
 
-- [Layeredimage](../README.md#layeredimage-index) / [Modules](../MODULES.md#layeredimage-modules) / Layeredimage
-    - Modules
-        - [Blend](blend.md#blend)
-        - [Io](io/index.md#io)
-        - [LayeredImage](layeredimage.md#layeredimage)
-        - [LayerGroup](layergroup.md#layergroup)
+- [Blend](./blend.md)
+- [Io](io/index.md)
+- [LayeredImage](./layeredimage.md)
+- [LayerGroup](./layergroup.md)

documentation/reference/layeredimage/index.md

@@ -1,36 +1,44 @@
 # Common
 
-> Auto-generated documentation for [layeredimage.io.common](../../../../layeredimage/io/common.py) module.
+[Layeredimage Index](../../README.md#layeredimage-index) /
+[Layeredimage](../index.md#layeredimage) /
+[Io](./index.md#io) /
+Common
 
-Do file io - Common Operations for file readers/writers.
+> Auto-generated documentation for [layeredimage.io.common](../../../../layeredimage/io/common.py) module.
 
-- [Layeredimage](../../README.md#layeredimage-index) / [Modules](../../MODULES.md#layeredimage-modules) / [Layeredimage](../index.md#layeredimage) / [Io](index.md#io) / Common
-    - [blendModeLookup](#blendmodelookup)
-    - [expandLayersToCanvas](#expandlayerstocanvas)
+- [Common](#common)
+  - [blendModeLookup](#blendmodelookup)
+  - [expandLayersToCanvas](#expandlayerstocanvas)
 
 ## blendModeLookup
 
-[[find in source code]](../../../../layeredimage/io/common.py#L13)
+[Show source in common.py:13](../../../../layeredimage/io/common.py#L13)
+
+Get the blendmode from a lookup table.
+
+#### Signature
 
 ```python
 def blendModeLookup(
-    blendmode: Any,
-    blendLookup: dict[Any, Any],
-    default: Any = BlendType.NORMAL,
+    blendmode: Any, blendLookup: dict[Any, Any], default: Any = BlendType.NORMAL
 ) -> BlendType:
+    ...
 ```
 
-Get the blendmode from a lookup table.
+
 
 ## expandLayersToCanvas
 
-[[find in source code]](../../../../layeredimage/io/common.py#L23)
+[Show source in common.py:23](../../../../layeredimage/io/common.py#L23)
+
+Return layers and throw a warning if the image has groups.
+
+#### Signature
 
 ```python
-def expandLayersToCanvas(
-    layeredImage: LayeredImage,
-    imageFormat: str,
-) -> list[Image]:
+def expandLayersToCanvas(layeredImage: LayeredImage, imageFormat: str) -> list[Image]:
+    ...
 ```
 
-Return layers and throw a warning if the image has groups.
+

documentation/reference/layeredimage/io/common.md

@@ -1,29 +1,42 @@
 # Gif
 
-> Auto-generated documentation for [layeredimage.io.gif](../../../../layeredimage/io/gif.py) module.
+[Layeredimage Index](../../README.md#layeredimage-index) /
+[Layeredimage](../index.md#layeredimage) /
+[Io](./index.md#io) /
+Gif
 
-Do file io - GIF.
+> Auto-generated documentation for [layeredimage.io.gif](../../../../layeredimage/io/gif.py) module.
 
-- [Layeredimage](../../README.md#layeredimage-index) / [Modules](../../MODULES.md#layeredimage-modules) / [Layeredimage](../index.md#layeredimage) / [Io](index.md#io) / Gif
-    - [openLayer_GIF](#openlayer_gif)
-    - [saveLayer_GIF](#savelayer_gif)
+- [Gif](#gif)
+  - [openLayer_GIF](#openlayer_gif)
+  - [saveLayer_GIF](#savelayer_gif)
 
 ## openLayer_GIF
 
-[[find in source code]](../../../../layeredimage/io/gif.py#L14)
+[Show source in gif.py:14](../../../../layeredimage/io/gif.py#L14)
+
+Open a .gif file into a layered image.
+
+#### Signature
 
 ```python
 def openLayer_GIF(file: str) -> LayeredImage:
+    ...
 ```
 
-Open a .gif file into a layered image.
+
 
 ## saveLayer_GIF
 
-[[find in source code]](../../../../layeredimage/io/gif.py#L32)
+[Show source in gif.py:32](../../../../layeredimage/io/gif.py#L32)
+
+Save a layered image as .gif.
+
+#### Signature
 
 ```python
 def saveLayer_GIF(fileName: str, layeredImage: LayeredImage) -> None:
+    ...
 ```
 
-Save a layered image as .gif.
+

documentation/reference/layeredimage/io/gif.md

@@ -1,53 +1,51 @@
 # Io
 
+[Layeredimage Index](../../README.md#layeredimage-index) /
+[Layeredimage](../index.md#layeredimage) /
+Io
+
 > Auto-generated documentation for [layeredimage.io](../../../../layeredimage/io/__init__.py) module.
 
-Do file io.
-
-- [Layeredimage](../../README.md#layeredimage-index) / [Modules](../../MODULES.md#layeredimage-modules) / [Layeredimage](../index.md#layeredimage) / Io
-    - [exportFlatImage](#exportflatimage)
-    - [extNotRecognised](#extnotrecognised)
-    - [openLayerImage](#openlayerimage)
-    - [saveLayerImage](#savelayerimage)
-    - Modules
-        - [Common](common.md#common)
-        - [Gif](gif.md#gif)
-        - [Layered](layered.md#layered)
-        - [Lsr](lsr.md#lsr)
-        - [Ora](ora.md#ora)
-        - [Pdn](pdn.md#pdn)
-        - [Psd](psd.md#psd)
-        - [Tiff](tiff.md#tiff)
-        - [Webp](webp.md#webp)
-        - [Xcf](xcf.md#xcf)
+- [Io](#io)
+  - [exportFlatImage](#exportflatimage)
+  - [extNotRecognised](#extnotrecognised)
+  - [openLayerImage](#openlayerimage)
+  - [saveLayerImage](#savelayerimage)
+  - [Modules](#modules)
 
 ## exportFlatImage
 
-[[find in source code]](../../../../layeredimage/io/__init__.py#L101)
+[Show source in __init__.py:101](../../../../layeredimage/io/__init__.py#L101)
+
+Export the layered image to a unilayer image file.
+
+#### Signature
 
 ```python
 def exportFlatImage(fileName: str, layeredImage: LayeredImage) -> None:
+    ...
 ```
 
-Export the layered image to a unilayer image file.
+
 
 ## extNotRecognised
 
-[[find in source code]](../../../../layeredimage/io/__init__.py#L23)
+[Show source in __init__.py:23](../../../../layeredimage/io/__init__.py#L23)
+
+Output the file extension not recognised error.
+
+#### Signature
 
 ```python
 def extNotRecognised(fileName: str):
+    ...
 ```
 
-Output the file extension not recognised error.
 
-## openLayerImage
 
-[[find in source code]](../../../../layeredimage/io/__init__.py#L32)
+## openLayerImage
 
-```python
-def openLayerImage(file: str) -> LayeredImage:
-```
+[Show source in __init__.py:32](../../../../layeredimage/io/__init__.py#L32)
 
 Open a layer image file into a layer image object.
 
@@ -64,14 +62,19 @@ Open a layer image file into a layer image object.
 
 - `LayeredImage` - a layered image object
 
-## saveLayerImage
-
-[[find in source code]](../../../../layeredimage/io/__init__.py#L68)
+#### Signature
 
 ```python
-def saveLayerImage(fileName: str, layeredImage: LayeredImage) -> None:
+def openLayerImage(file: str) -> LayeredImage:
+    ...
 ```
 
+
+
+## saveLayerImage
+
+[Show source in __init__.py:68](../../../../layeredimage/io/__init__.py#L68)
+
 Save a layered image to a file.
 
 #### Arguments
@@ -86,3 +89,25 @@ Save a layered image to a file.
 #### Returns
 
 None
+
+#### Signature
+
+```python
+def saveLayerImage(fileName: str, layeredImage: LayeredImage) -> None:
+    ...
+```
+
+
+
+## Modules
+
+- [Common](./common.md)
+- [Gif](./gif.md)
+- [Layered](./layered.md)
+- [Lsr](./lsr.md)
+- [Ora](./ora.md)
+- [Pdn](./pdn.md)
+- [Psd](./psd.md)
+- [Tiff](./tiff.md)
+- [Webp](./webp.md)
+- [Xcf](./xcf.md)