Merge pull request #10485 from dunkmann00/static-stubs

Add a static stubs directory

Author: FoamyGuy

Makefile

@@ -280,6 +280,7 @@ stubs:
 	sed -e "s,__version__,`python -msetuptools_scm`," < setup.py-stubs > circuitpython-stubs/setup.py
 	cp README.rst-stubs circuitpython-stubs/README.rst
 	cp MANIFEST.in-stubs circuitpython-stubs/MANIFEST.in
+	cp -r stubs/* circuitpython-stubs
 	$(PYTHON) tools/board_stubs/build_board_specific_stubs/board_stub_builder.py
 	cp -r tools/board_stubs/circuitpython_setboard circuitpython-stubs/circuitpython_setboard
 	$(PYTHON) -m build circuitpython-stubs

docs/library/index.rst

@@ -54,4 +54,4 @@ the following libraries.
 .. toctree::
    :maxdepth: 1
 
-   micropython.rst
+   ../../shared-bindings/micropython/index.rst

docs/library/micropython.rst

@@ -1,4 +1,5 @@
 index.rst README.html
+docs/library/micropython.rst shared-bindings/micropython
 shared-bindings//__init__.rst shared-bindings//
 shared-bindings/_bleio/Adapter.rst shared-bindings/_bleio/#_bleio.Adapter
 shared-bindings/_bleio/Address.rst shared-bindings/_bleio/#_bleio.Address

docs/redirects.txt

@@ -0,0 +1,20 @@
+"""Access and control MicroPython internals"""
+
+def const[T](expr: T) -> T:
+    """Used to declare that the expression is a constant so that the compiler
+    can optimise it. The use of this function should be as follows::
+
+        from micropython import const
+
+        CONST_X = const(123)
+        CONST_Y = const(2 * CONST_X + 1)
+
+    Constants declared this way are still accessible as global variables from
+    outside the module they are declared in. On the other hand, if a constant
+    begins with an underscore then it is hidden, it is not available as a global
+    variable, and does not take up any memory during execution.
+
+    This `const` function is recognised directly by the MicroPython parser and is
+    provided as part of the :mod:`micropython` module mainly so that scripts can be
+    written which run under both CPython and MicroPython, by following the above
+    pattern."""