Skip to content

Some Requirements missing in sphinx container #96

Closed
@FoamyGuy

Description

@FoamyGuy

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:

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions