Skip to content
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.

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

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

Open
FoamyGuy opened this issue Oct 5, 2024 · 0 comments
Open

Comments

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Oct 5, 2024

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]):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant