Fix and improved in documentation

Author: CDarius

axp192.py

@@ -97,7 +97,7 @@ class AXP192:
     should expose a property to control the DCDC3 brightness
 
     :param ~busio.I2C i2c: The I2C bus AXP192 is connected to
-    :param int device_address: The I2C bus addres. Default to `0x34`
+    :param int device_address: The I2C bus addres. Default to 0x34
 
     **Quickstart: Importing and using the device**
 
@@ -286,15 +286,15 @@ def all_adc_enabled(self, enable: bool) -> None:
 
     @property
     def internal_temperature(self) -> float:
-        """Internal AXP192 temperature in Celsius degree"""
+        """Internal AXP192 temperature in Celsius degrees"""
         return -144.7 + 0.1 * self._read_register12(0x5E)
 
     @property
     def power_key_was_pressed(self) -> Tuple[bool, bool]:
         """Power key pressed status
 
         :returns: Two booleans: Power key is short press and power key is long press
-        _rtype: tuple(bool, bool)
+        :rtype: tuple(bool, bool)
         """
         reg_val = self._read_register8(_AXP192_IRQ_3_STATUS)
         short_press = (reg_val & _AXP192_IRQ_3_STATUS_PEK_SHORT_PRESS) != 0

docs/examples.rst

@@ -1,8 +1,28 @@
 Simple test
 ------------
 
-Ensure your device works with this simple test.
+Ensure your device works with this simple test, it show the battery voltage
+if a battery is connected to AXP192
 
 .. literalinclude:: ../examples/axp192_simpletest.py
     :caption: examples/axp192_simpletest.py
     :linenos:
+
+Power key pressed test
+----------------------
+
+Simple test to show how to read the power key button status
+
+.. literalinclude:: ../examples/axp192_power_key_press.py
+    :caption: examples/axp192_power_key_press.py
+    :linenos:
+
+Extending AXP192 library
+------------------------
+
+A more complex example that show how to extend the AXP192 library. This example extend
+the AXP192 library and create a :py:class:`PMIC` for the  `M5Stack Core2 <https://docs.m5stack.com/en/core/core2>`_
+
+.. literalinclude:: ../examples/axp192_m5stack_core2_pmic.py
+    :caption: examples/axp192_m5stack_core2_pmic.py
+    :linenos:

docs/index.rst

@@ -21,18 +21,6 @@ Table of Contents
 
     api
 
-.. toctree::
-    :caption: Tutorials
-
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
-.. toctree::
-    :caption: Related Products
-
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Other Links
 

examples/axp192_m5stack_core2_pmic.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023 Dario Cammi
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
 import time
 import board

examples/axp192_power_key_press.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023 Dario Cammi
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
 import time
 import board

examples/axp192_simpletest.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023 Dario Cammi
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
 import time
 import board