Cian-H/read_aconity_layers
1
0
Fork 0
mirror of https://github.com/Cian-H/read_aconity_layers.git synced 2025-12-22 18:31:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added autogenerated sphinx documentation

Browse Source
This commit is contained in:
Cian Hughes
2025-05-28 15:12:44 +01:00
parent 0ad146179c
commit 0b0a0ca5c5
13 changed files with 1824 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/python/index.rst Normal file
View File

@@ -0,0 +1,25 @@
Python API Reference
====================
This section contains the complete Python API reference for ``read_aconity_layers``.
Module
-----------
.. automodule:: read_aconity_layers
:members:
:undoc-members:
:show-inheritance:
Return Type Information
-----------------------
The library includes comprehensive type stubs for full IDE support and type checking.
All functions return NumPy arrays with the following structure:
* **Column 0**: X coordinates (corrected)
* **Column 1**: Y coordinates (corrected)
* **Column 2**: Z coordinates (layer height)
* **Column 3**: Pyrometer 1 readings
* **Column 4**: Pyrometer 2 readings