Skip to content

Commit

Permalink
Update Api_Reference.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
AkshuDev authored Dec 10, 2024
1 parent 4468313 commit 990cdc2
Showing 1 changed file with 2 additions and 37 deletions.
39 changes: 2 additions & 37 deletions docs/source/Api_Reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -469,43 +469,8 @@ The `apis.PACI` module provides a robust API for managing and installing Pheonix

**Description**: This folder will include all the user connected modules.

PHardwareITK
PHardwareITK (phardwareitk)
------------

**Description:**

The `PHardwareITK` library provides a comprehensive toolkit for interacting with hardware components and functionalities. It offers functionalities for various hardware-related tasks, including:

* Error handling and system management
* File system operations
* Graphical User Interface (GUI) development
* Hardware control and interaction (details to be filled based on available functionalities)
* Module management and control
* Low-level programming aspects (details to be filled based on available functionalities)

# Files

**Description**: The files directly available in the phardwareitk module.

## LIB
**Internal Paths:**

The `phardwareitk.LIB` module establishes various file paths within the library structure. These paths are used to access sub-modules and functionalities.

**Classes:**

**1. Paths:**

This class provides pre-defined paths to various directories and files within the `PHardwareITK` library. It avoids the need for manually constructing paths throughout the codebase.

**Example:**

.. code-block:: python
import phardwareitk.LIB as phLIB
# Access the path to the ErrorSystem directory
error_system_path = phLIB.Paths.ErrorSystem
print(error_system_path) # Output: /path/to/phardwareitk/ErrorSystem
This is a huge module and its resources can be found in the PHardwareITK_Reference!
---

0 comments on commit 990cdc2

Please sign in to comment.