adafruit / adabot

Adabot is our robot friend who helps Adafruit online
MIT License
13 stars 27 forks source link

docs link is omitted from library list .md files for Adafruit bundle #380

Open FoamyGuy opened 1 month ago

FoamyGuy commented 1 month ago

I'm pretty sure that the .md file here: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/circuitpython_library_list.md used to contain links to the docs for each library in addition to the pypi link. The similar file in the community bundle does contain the docs links.

I believe it likely stopped working when the docs links in the readme.rst files of each library repo was changed to use a circuitpython.org URL instead of a readthedocs.io one due to the logic here: https://github.com/adafruit/adabot/blob/main/adabot/lib/common_funcs.py#L223 looking for "readthedocs" in the link of the readme.rst file.

I think if it were updated to this it should go back to working (and work in both Adafruit bundle and Community):

if "target" in lines[i] and ("readthedocs" in lines[i] or "docs.circuitpython.org" in lines[i]):