adafruit / Adafruit_CircuitPython_Bundle

A bundle of useful CircuitPython libraries ready to use from the filesystem.
MIT License
875 stars 189 forks source link

docs/drivers.rst does not include import name #462

Closed dhalbert closed 1 day ago

dhalbert commented 5 months ago

The libraries list in docs/drivers.rst does not visibly include the import name of the library. For instance, if I am looking for the adafruit_esp32spi library documentation, and searching for the string "esp32spi", I won't find it, because the entry is:

ESP32 WiFi Co-Processor over SPI

I think it would be helpful if the entry looked something like one of these instead. The exact formatting is an aesthetic choice.

ESP32 WiFi Co-Processor over SPI (adafruit_esp32spi)

ESP32 WiFi Co-Processor over SPI: adafruit_esp32spi

etc.

This would also help with websearch indexing.