Skip to content

Some Requirements missing in sphinx container #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
FoamyGuy opened this issue Jan 9, 2022 · 2 comments
Closed

Some Requirements missing in sphinx container #96

FoamyGuy opened this issue Jan 9, 2022 · 2 comments

Comments

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Jan 9, 2022 •
edited
Loading

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

import adafruit_esp32spi.adafruit_esp32spi_socket as esp32_socket
import adafruit_wiznet5k.adafruit_wiznet5k_socket as wiznet_socket
import adafruit_fona.adafruit_fona_socket as cellular_socket
from adafruit_esp32spi.adafruit_esp32spi import ESP_SPIcontrol
from adafruit_wiznet5k.adafruit_wiznet5k import WIZNET5K
from adafruit_fona.adafruit_fona import FONA

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
Copy link
Contributor Author

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
Copy link
Contributor Author

#94 will serve as the solution to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@FoamyGuy