Circuitpython doc move #426
Conversation
* Move most documentation out of the ulab base module. * float -> _float * ulab.ndarray -> ulab.numpy.ndarray This still does not build unless it is taken together with a modification to CircuitPython that _also_ moves references to ulab.numpy. Because of this, this PR will continue to show red. The suitability of the changes can be gaged by looking at the related CircuitPython PR build or by running locally the build-cp.sh script with the right ref checked out in circuitpython/
|
@jepler OK, I will look at it later today. Thanks for following up on this! |
|
@jepler Jeff, thanks again for taking care of this! I don't see any problems here, so we can merge the PR. (I don't know if your list is chronological, i.e., whether the approval of the first point must precede that of the second). I can prepare a release, no problem. I believe, there are two new functions/methods since the last release. |
|
It's semi-chronological, so green + approved on the circuitpython PR is what I'd wait for next. |
…aces This allows the build to be green in ulab before the changes in circuitpython. After circuitpython's _typing/__init__.py is fixed to use the new canonical location, this temporary alias can be removed.
|
I think I found a way that gives forward compatibility, so if this turns out green I'll merge it. |
Fine with me. |
…roper Otherwise, an error occurred, but only on the macos build(!) ``` ulab/scipy/optimize/__init__.pyi:7: error: Name "_float" is not defined ``` It's not clear why `_float` was apparently defined on Linux in this context.
|
@v923z yay -- ping me when you have had time to make a release and I'll start the ball rolling in circuitpython to pull that version in. Thanks for doing the initial work on this doc stuff as well! |
|
@jepler I can create a tag before 1pm, your time. |
2 participants
This builds on #423 and also works together with adafruit/circuitpython#5028 to complete the doc move. (If we take this PR, then #423 is moot)
However, this build will come up in red for the circuitpython builds because without adafruit/circuitpython#5028 (which renames some use of ulab.ndarray to ulab.numpy.ndarray within our own pyi/docs) it is still not OK.
I didn't find a way for both things to work together, so the possibility I see is to (approximately in order):
then we can all be green again.
Closes: #419