docs

Author: BlitzCityDIY

README.rst

@@ -23,34 +23,24 @@ Introduction
 
 PortalBase helper library for the Yoto Players
 
-
 Dependencies
 =============
 This driver depends on:
 
 * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
 * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
 * `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
+* `PortalBase <https://github.com/adafruit/Adafruit_CircuitPython_PortalBase>`_
+* `PCF8563 <https://github.com/adafruit/Adafruit_CircuitPython_PCF8563>`_
 
 Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
 or individual libraries can be installed using
 `circup <https://github.com/adafruit/circup>`_.
 
-
-
-.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
-image from the assets folder in the PCB's GitHub repo.
-
-`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
-
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-yotoplayer/>`_.
@@ -101,8 +91,38 @@ Or the following command to update an existing version:
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the
-examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+    from adafruit_yoto import Yoto
+
+    yoto = Yoto(
+    default_bg=0x000000,
+    rotation=0,
+    debug=False,
+    auto_refresh=True,
+    )
+
+    title_index = yoto.add_text(
+        text="Hello World!",
+        text_position=(yoto.display.width // 2, yoto.display.height // 2),
+        text_color=CYAN,
+        text_scale=3,
+        text_anchor_point=(0.5, 0.5),
+        is_data=False
+    )
+
+    if yoto.peripherals.nfc:
+        print(f"NFC: {yoto.peripherals.nfc.device_name}")
+    if yoto.peripherals.dac:
+        print(f"DAC: ES8156 (Chip ID: {yoto.peripherals.dac.chip_id:04X})")
+    if yoto.peripherals.battery:
+        part = yoto.peripherals.battery.part_info
+        print(f"Battery: {part['part_number']}")
+    if yoto.peripherals.rtc:
+        print(f"RTC: {'Valid' if yoto.peripherals.rtc_valid else 'Needs Set'}")
+    
+    while True:
+        pass
 
 Documentation
 =============

adafruit_yoto/__init__.py

@@ -13,7 +13,7 @@
 """
 
 __version__ = "0.0.0+auto.0"
-__repo__ = "https://github.com/yourrepo/Adafruit_CircuitPython_Yoto.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_YotoPlayer.git"
 
 from adafruit_yoto.yoto import Yoto
 from adafruit_yoto.peripherals import Peripherals

adafruit_yoto/graphics.py

@@ -31,7 +31,7 @@
 from adafruit_portalbase.graphics import GraphicsBase
 
 __version__ = "0.0.0+auto.0"
-__repo__ = "https://github.com/yourrepo/Adafruit_CircuitPython_Yoto.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_YotoPlayer.git"
 
 
 class Graphics(GraphicsBase):

adafruit_yoto/network.py

@@ -31,7 +31,7 @@
 from adafruit_portalbase.wifi_esp32s2 import WiFi
 
 __version__ = "0.0.0+auto.0"
-__repo__ = "https://github.com/yourrepo/Adafruit_CircuitPython_Yoto.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_YotoPlayer.git"
 
 
 class Network(NetworkBase):

adafruit_yoto/peripherals.py

@@ -37,7 +37,7 @@
 from adafruit_pcf8563.pcf8563 import PCF8563
 
 __version__ = "0.0.0+auto.0"
-__repo__ = "https://github.com/yourrepo/Adafruit_CircuitPython_Yoto.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_YotoPlayer.git"
 
 
 class Peripherals:

adafruit_yoto/yoto.py

@@ -34,7 +34,7 @@
 from adafruit_yoto.peripherals import Peripherals
 
 __version__ = "0.0.0+auto.0"
-__repo__ = "https://github.com/yourrepo/Adafruit_CircuitPython_Yoto.git"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_YotoPlayer.git"
 
 
 class Yoto(PortalBase):

docs/api.rst

@@ -7,5 +7,23 @@
 API Reference
 #############
 
-.. automodule:: adafruit_yotoplayer
+.. automodule:: adafruit_yoto.cr95hf
+    :members:
+
+.. automodule:: adafruit_yoto.es8156
+    :members:
+
+.. automodule:: adafruit_yoto.graphics
+    :members:
+
+.. automodule:: adafruit_yoto.network
+    :members:
+
+.. automodule:: adafruit_yoto.peripherals
+    :members:
+
+.. automodule:: adafruit_yoto.sgm41513
+    :members:
+
+.. automodule:: adafruit_yoto.yoto
     :members:

docs/conf.py

@@ -25,7 +25,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["digitalio", "busio", "audiobusio", "rotaryio", ]
 
 autodoc_preserve_defaults = True
 

docs/index.rst

@@ -24,14 +24,7 @@ Table of Contents
 .. 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.
+    Hacking the Yoto Music Players Learn Guide <https://learn.adafruit.com/hacking-the-yoto-music-players>
 
 .. toctree::
     :caption: Other Links