Update stubs documentation

Signed-off-by: Jos Verlinde <[email protected]>
Josverl · Aug 27, 2024 · 145c470 · 145c470
1 parent f5ed1a8
commit 145c470
Show file tree

Hide file tree

Showing 6 changed files with 114 additions and 113 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -23,43 +23,64 @@
         "titleBar.inactiveForeground": "#e7e7e799"
     },
     "peacock.color": "#215732",
+    // To ignore ALL CAPS in all files
+    "cSpell.ignoreRegExpList": [
+        "/\\b[A-Z]+\\b/g"
+    ],
     "cSpell.words": [
+        "ADAFRUIT",
         "builtins",
         "clearcache",
         "colorstubs",
         "contextlib",
         "cpython",
+        "dataframe",
         "debugpy",
         "docstrings",
         "docstubs",
         "firmwares",
         "flatgithub",
         "flatview",
+        "flowui",
+        "GARATRONIC",
         "genindex",
         "josverl",
         "Loboris",
+        "LOLIN",
         "LVGL",
         "maxdepth",
         "microbit",
+        "micropico",
         "modindex",
+        "modulename",
         "mpremote",
         "mypy",
         "MYPYPATH",
         "Pico",
+        "PICOLIPO",
+        "PIMORONI",
         "PSRAM",
         "pwsh",
+        "PYBD",
+        "pyboard",
+        "PYBSTICK",
+        "PYBV",
         "pycopy",
         "pylance",
         "pylint",
         "pylintrc",
+        "pypi",
         "pyproject",
         "pyright",
         "pyrightconfig",
+        "renesas",
         "SAMD",
+        "SEEED",
         "spiram",
         "stdlib",
         "stinos",
         "stubgen",
+        "TINYPICO",
         "toctree",
         "Traceback",
         "typeshed",
@@ -82,5 +103,6 @@
     "[python]": {
         "editor.defaultFormatter": "ms-python.black-formatter"
     },
-    "python.formatting.provider": "none"
+    "python.formatting.provider": "none",
+    "python.analysis.supportRestructuredText": true
 }
diff --git a/docs/index.md b/docs/index.md
@@ -37,7 +37,7 @@ qa_testing.md
 
 ```{toctree}
 :caption: 'Stub index'
-:maxdepth: 2
+:maxdepth: 3
 packages.md
 package_flatview.md
 firmware_grp.md