docs: Apply all initial OpenMV changes from v4.8.1.

Author: kwagyeman

.gitignore

@@ -10,6 +10,7 @@
 build/
 build-*/
 docs/genrst/
+docs/_build/
 
 # Test failure outputs and intermediate artefacts
 tests/results/*
@@ -18,6 +19,9 @@ tests/ports/unix/ffi_lib.so
 # Python cache files
 __pycache__/
 
+# Compiled translation files
+docs/**/*.mo
+
 # Customized Makefile/project overrides
 GNUmakefile
 user.props

docs/conf.py

@@ -72,20 +72,24 @@
 
 # General information about the project.
 project = "MicroPython"
-copyright = "- The MicroPython Documentation is Copyright © 2014-2026, " + micropy_authors
+copyright = "- The MicroPython Documentation is Copyright © 2014-2026, Damien P. George, Paul Sokolovsky, and contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # 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 = micropy_version
+version = release = "1.26"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None
 
+# -- Options for i18n output ----------------------------------------------
+locale_dirs = ["locale"]
+gettext_compact = False
+
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 # today = ''
@@ -94,7 +98,75 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["build", ".venv"]
+exclude_patterns = [
+    "build",
+    ".venv",
+    "esp32",
+    "esp8266",
+    "pyboard",
+    "wipy",
+    "library/btree.rst",
+    "library/esp.rst",
+    "library/espnow.rst",
+    "library/esp32.rst",
+    "library/framebuf.rst",
+    "library/rp2.rst",
+    "library/rp2.DMA.rst",
+    "library/rp2.Flash.rst",
+    "library/rp2.PIO.rst",
+    "library/rp2.StateMachine.rst",
+    "library/wm8960.rst",
+    "library/zephyr.rst",
+    "library/zephyr.DiskAccess.rst",
+    "library/zephyr.FlashArea.rst",
+    "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",
+    "library/wipy.rst",
+    "mimxrt/general.rst",
+    "mimxrt/pinout.rst",
+    "mimxrt/tutorial/intro.rst",
+    "mimxrt/quickref.rst",
+    "renesas-ra/general.rst",
+    "renesas-ra/quickref.rst",
+    "renesas-ra/tutorial/index.rst",
+    "renesas-ra/tutorial/intro.rst",
+    "renesas-ra/tutorial/program_in_flash.rst",
+    "renesas-ra/tutorial/reset.rst",
+    "renesas-ra/tutorial/troubleshooting.rst",
+    "renesas-ra/tutorial/using_peripheral.rst",
+    "rp2/general.rst",
+    "rp2/quickref.rst",
+    "rp2/tutorial/intro.rst",
+    "rp2/tutorial/pio.rst",
+    "rp2/tutorial/reset.rst",
+    "samd/general.rst",
+    "samd/quickref.rst",
+    "samd/pinout.rst",
+    "samd/tutorial/intro.rst",
+    "unix/quickref.rst",
+    "zephyr/general.rst",
+    "zephyr/quickref.rst",
+    "zephyr/tutorial/index.rst",
+    "zephyr/tutorial/intro.rst",
+    "zephyr/tutorial/pins.rst",
+    "zephyr/tutorial/repl.rst",
+    "zephyr/tutorial/storage.rst",
+]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -131,7 +203,18 @@
 
 import sphinx_rtd_theme
 
-html_theme = "sphinx_rtd_theme"
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    try:
+        import sphinx_rtd_theme
+
+        html_theme = "sphinx_rtd_theme"
+    except:
+        html_theme = "default"
+        html_theme_path = ["."]
+else:
+    html_theme_path = ["."]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -150,12 +233,12 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-# html_logo = '../../logo/trans-logo.png'
+html_logo = "../../openmv-media/logos/openmv-logo-white/web-logo-sticky.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-html_favicon = "static/favicon.ico"
+html_favicon = "../../openmv-media/icons/openmv-icon/openmv.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -237,7 +320,7 @@
         master_doc,
         "MicroPython.tex",
         "MicroPython Documentation",
-        micropy_authors,
+        "Damien P. George, Paul Sokolovsky, OpenMV LLC, and contributors",
         "manual",
     ),
 ]
@@ -274,7 +357,7 @@
         "index",
         "micropython",
         "MicroPython Documentation",
-        [micropy_authors],
+        ["Damien P. George, Paul Sokolovsky, OpenMV LLC, and contributors"],
         1,
     ),
 ]
@@ -293,7 +376,7 @@
         master_doc,
         "MicroPython",
         "MicroPython Documentation",
-        micropy_authors,
+        "Damien P. George, Paul Sokolovsky, OpenMV LLC, and contributors",
         "MicroPython",
         "One line description of project.",
         "Miscellaneous",

docs/index.rst

@@ -8,13 +8,4 @@ MicroPython documentation and references
     genrst/index.rst
     develop/index.rst
     license.rst
-    pyboard/quickref.rst
-    esp8266/quickref.rst
-    esp32/quickref.rst
-    rp2/quickref.rst
-    mimxrt/quickref.rst
-    wipy/quickref.rst
-    unix/quickref.rst
-    zephyr/quickref.rst
-    renesas-ra/quickref.rst
-    samd/quickref.rst
+    openmvcam/quickref.rst

docs/library/btree.rst

@@ -5,7 +5,7 @@
    :synopsis: simple BTree database
 
 The ``btree`` module implements a simple key-value database using external
-storage (disk files, or in general case, a random-access `stream`). Keys are
+storage (disk files, or in general case, a random-access ``stream``). Keys are
 stored sorted in the database, and besides efficient retrieval by a key
 value, a database also supports efficient ordered range scans (retrieval
 of values with the keys in a given range). On the application interface
@@ -79,7 +79,7 @@ Functions
 
 .. function:: open(stream, *, flags=0, pagesize=0, cachesize=0, minkeypage=0)
 
-   Open a database from a random-access `stream` (like an open file). All
+   Open a database from a random-access :std:term:`stream` (like an open file). All
    other parameters are optional and keyword-only, and allow to tweak advanced
    parameters of the database operation (most users will not need them):
 

docs/library/cmath.rst

@@ -9,9 +9,6 @@
 The ``cmath`` module provides some basic mathematical functions for
 working with complex numbers.
 
-Availability: not available on WiPy and ESP8266. Floating point support
-required for this module.
-
 Functions
 ---------