docs: Update docuementation to OpenMV v5.0.0.

Author: kwagyeman

docs/conf.py

@@ -26,6 +26,9 @@
 micropy_all_versions = (os.getenv("MICROPY_ALL_VERSIONS") or "latest").split(",")
 url_pattern = "%s/en/%%s" % (os.getenv("MICROPY_URL_PREFIX") or "/",)
 
+# The OpenMV firmware version this documentation describes.
+openmv_version = "5.0.0"
+
 # The members of the html_context dict are available inside topindex.html
 html_context = {
     "cur_version": micropy_version,
@@ -34,6 +37,7 @@
         ("PDF", url_pattern % micropy_version + "/micropython-docs.pdf"),
     ],
     "is_release": micropy_version != "latest",
+    "openmv_version": openmv_version,
 }
 
 # Authors used in various parts of the documentation.
@@ -80,7 +84,7 @@
 #
 # We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"
 # breakdown, so use the same version identifier for both to avoid confusion.
-version = release = "1.26"
+version = release = "1.28"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -105,11 +109,15 @@
     "esp8266",
     "pyboard",
     "wipy",
+    "library/_thread.rst",
     "library/btree.rst",
+    "library/weakref.rst",
+    "library/omv.uftpd.rst",
+    "library/omv.utelnet.rst",
+    "library/omv.uping.rst",
     "library/esp.rst",
     "library/espnow.rst",
     "library/esp32.rst",
-    "library/framebuf.rst",
     "library/rp2.rst",
     "library/rp2.DMA.rst",
     "library/rp2.Flash.rst",
@@ -122,17 +130,13 @@
     "library/zephyr.zsensor.rst",
     "library/lcd160cr.rst",
     "library/machine.ADCWiPy.rst",
-    "library/machine.Counter.rst",
     "library/machine.DAC.rst",
-    "library/machine.Encoder.rst",
     "library/machine.SD.rst",
-    "library/machine.SDCard.rst",
     "library/machine.TimerWiPy.rst",
     "library/machine.USBDevice.rst",
     "library/network.CC3K.rst",
     "library/network.WIZNET5K.rst",
     "library/network.WLANWiPy.rst",
-    "library/neopixel.rst",
     "library/pyb.Accel.rst",
     "library/pyb.LCD.rst",
     "library/pyb.Switch.rst",

docs/library/_thread.rst

@@ -4,9 +4,77 @@
 .. module:: _thread
    :synopsis: multithreading support
 
-|see_cpython_module| :mod:`python:_thread`.
+This module provides low-level primitives for working with multiple threads
+of execution: spawning new threads, querying the current thread identifier,
+and creating mutex locks for synchronisation.  It is intended as a foundation
+for higher-level threading abstractions.
 
-This module implements multithreading support.
+A thread, once started, executes independently from the thread that spawned it.
+There is no built-in way to join, cancel, or otherwise interact with a running
+thread; synchronisation must be performed explicitly using lock objects.
 
-This module is highly experimental and its API is not yet fully settled
-and not yet described in this documentation.
+Functions
+---------
+
+.. function:: start_new_thread(function: Callable[..., Any], args: tuple, kwargs: dict | None = None) -> int
+
+   Start a new thread that runs ``function(*args, **kwargs)`` and return its
+   integer thread identifier.  *args* must be a tuple of positional arguments;
+   *kwargs*, if given, must be a dict of keyword arguments.
+
+   If the thread terminates with an unhandled exception (other than
+   :exc:`SystemExit`), a traceback is printed and the thread exits.
+
+.. function:: exit() -> None
+
+   Raise :exc:`SystemExit` in the calling thread, terminating it.  This has
+   the same effect as ``raise SystemExit``.
+
+.. function:: get_ident() -> int
+
+   Return the integer "thread identifier" of the current thread.  The value
+   has no direct meaning beyond identifying a particular thread for the
+   lifetime of that thread.
+
+.. function:: allocate_lock() -> Lock
+
+   Return a new lock object (initially unlocked).  See the :class:`Lock`
+   class below for details.
+
+.. function:: stack_size(size: int = 0, /) -> int
+
+   Return the thread stack size used when creating new threads.  The optional
+   *size* argument sets the stack size, in bytes, to be used for subsequently
+   created threads; a value of ``0`` selects the platform default.  The
+   previous value is returned.
+
+Lock objects
+------------
+
+.. class:: Lock
+
+   A primitive mutex (mutual exclusion) lock.  When locked, it belongs to
+   the thread that locked it; when unlocked, it does not belong to any
+   thread.  Lock objects are created via :func:`allocate_lock` and cannot
+   be instantiated directly.
+
+   Lock objects support the context manager protocol: using a lock with the
+   ``with`` statement acquires it on entry and releases it on exit.
+
+   .. method:: acquire(blocking: bool = True, /) -> bool
+
+      Acquire the lock.  If *blocking* is true (the default), block until
+      the lock is available, then take it and return ``True``.  If
+      *blocking* is false, return ``True`` immediately if the lock could
+      be taken, or ``False`` if it could not.
+
+   .. method:: release() -> None
+
+      Release the lock, allowing another thread that is blocked waiting
+      for it to proceed.  The lock must be held by the calling thread;
+      calling :meth:`release` on an unlocked lock raises :exc:`RuntimeError`.
+
+   .. method:: locked() -> bool
+
+      Return ``True`` if the lock is currently held by some thread, and
+      ``False`` otherwise.