Some Requirements missing in sphinx container
FoamyGuy opened this issue · 2 comments
When sphinx runs inside of the github actions container it installs everything from requirements.txt
There are some libraries currently used for typing here that are not currently included in requirements.txt:
Adafruit_CircuitPython_Requests/adafruit_requests.py
Lines 46 to 51 in 26b2411
I think these missing requirements are causing CI docs builds like this one: https://github.com/adafruit/Adafruit_CircuitPython_FunHouse/pull/28/checks
Ultimately I think we'll want to include all of those libraries when the docs are built so that type links can work. But maybe we don't want to require them for normal operation?
#95 is a minimal attempt to mitigate this issue by falling back to None if the typing imports fail. So that sphinx can finish successfully.
We discussed this "in the weeds" during the meeting on 1-10-21.
Preferred direction is to declare minimal Typing interfaces within this library (or perhaps moved to core some day if other libraries make use of the same type).
I'll close this issue and plan to open a PR that switches this using the interface object instead of the imports