adafruit / Adafruit_CircuitPython_Requests

Requests-like interface for web interfacing
MIT License
51 stars 36 forks source link

Some Requirements missing in sphinx container #96

Closed FoamyGuy closed 2 years ago

FoamyGuy commented 2 years ago

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: https://github.com/adafruit/Adafruit_CircuitPython_Requests/blob/26b2411780f69edece156c25476359242446bac0/adafruit_requests.py#L46-L51

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.

FoamyGuy commented 2 years ago

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

FoamyGuy commented 2 years ago

94 will serve as the solution to this.