jedi: add new pybricks_jedi package

This package will be used in Pybricks Code to provide some intellesense
operations.

Author: dlech

.github/workflows/jedi.yml

@@ -0,0 +1,33 @@
+name: pybricks_jedi
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    if: github.ref_type != 'tag'
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+    - run: pipx install poetry
+    - run: poetry install
+      working-directory: ./jedi
+    - run: poetry run pytest -vv
+      working-directory: ./jedi
+
+  publish:
+    if: github.ref_type == 'tag' && startsWith(github.ref_name, 'pybricks_jedi/')
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+    - run: pipx install poetry
+    - run: poetry install
+    - run: poetry build
+    - run: poetry publish
+      env:
+        POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_PYBRICKS_JEDI_TOKEN }}

.gitignore

@@ -26,8 +26,9 @@ build/
 build-*/
 _build/
 
-# Test failure outputs
+# Tests
 ######################
+.pytest_cache/
 tests/*.exp
 tests/*.out
 

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+    "python.autoComplete.extraPaths": ["jedi/src"],
     "python.formatting.provider": "black",
     "python.linting.pylintEnabled": false,
     "python.linting.flake8Enabled": true,
@@ -9,6 +10,11 @@
         "editor.defaultFormatter": "ms-python.python"
     },
     "python.languageServer": "Pylance",
+    "python.testing.pytestArgs": [
+        "jedi/tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
     "files.associations": {"*.inc": "restructuredtext"},
     "restructuredtext.confPath": "${workspaceFolder}/doc/main",
     "spellright.language": [
@@ -40,4 +46,7 @@
         "restructuredtext",
     ],
     "rewrap.wrappingColumn": 78,
+    "python.analysis.extraPaths": [
+        "jedi/src"
+    ],
 }

doc/common/conf.py

@@ -27,6 +27,9 @@
 from docutils.parsers.rst.directives import flag
 from docutils.parsers.rst import Directive
 from sphinx.application import Sphinx
+from sphinx.addnodes import pending_xref
+from sphinx.environment import BuildEnvironment
+from sphinx.util.nodes import make_refnode
 import toml
 
 TOP_DIR = os.path.abspath(os.path.join("..", ".."))
@@ -307,7 +310,16 @@ def run(self):
         ]
 
 
-def on_missing_reference(app, env, node, contnode):
+def on_missing_reference(
+    app: Sphinx, env: BuildEnvironment, node: pending_xref, contnode: nodes.Element
+) -> nodes.Element:
+    # The Number type alias is on the Signals and Units page instead of on the
+    # pybricks.parameters page so normal resolution doesn't work
+    if node["reftype"] == "class" and node["reftarget"] == "Number":
+        return make_refnode(
+            app.builder, node["refdoc"], "signaltypes", "numbers", contnode
+        )
+
     # References with special characters can't exist, so we have to supress
     # warnings when Sphinx tries to cross reference units like deg/s. For
     # consistency, we also treat units without special characters this way.

doc/main/conf.py

@@ -25,6 +25,9 @@
 if os.environ.get("READTHEDOCS", None) == "True":
     tags.add("main")  # noqa F821
 
+# HACK: this allows Number type alias to be imported by Sphinx
+os.environ["SPHINX_BUILD"] = "True"
+
 # Addtional configuration of the IDE docs
 if "ide" in tags.tags:  # noqa F821
     _DISCLAIMER = ""

doc/main/signaltypes.rst

@@ -7,22 +7,8 @@ quantities. This page gives an overview of each quantity and its unit.
 Numbers
 ~~~~~~~
 
-.. class:: Number
-
-Numbers can be represented as integers or floating point values:
-
-    * Integers (:class:`int <ubuiltins.int>`) are whole numbers
-      like ``15`` or ``-123``.
-    * Floating point values (:class:`float <ubuiltins.float>`) are decimal
-      numbers like ``3.14`` or ``-123.45``.
-
-If you see :class:`Number <Number>` as the argument type, both
-:class:`int <ubuiltins.int>` and :class:`float <ubuiltins.float>` may be used.
-
-For example, :func:`wait(15) <pybricks.tools.wait>` and
-:func:`wait(15.75) <pybricks.tools.wait>` are both allowed. In most functions,
-however, your input value will be truncated to a whole number anyway. In this
-example, either command makes the program pause for just 15 milliseconds.
+.. autodata:: pybricks.parameters.Number
+  :noindex:
 
 Time
 ~~~~~~