Skip to content

Turn libraries list on board pages into links#1453

Merged
tannewt merged 2 commits intomainfrom
turn-libraries-into-links
Aug 19, 2024
Merged

Turn libraries list on board pages into links#1453
tannewt merged 2 commits intomainfrom
turn-libraries-into-links

Conversation

@tyeth
Copy link
Copy Markdown
Member

@tyeth tyeth commented Aug 17, 2024

This turns the library list on board pages into clickable docs links.
It supports having class links like busio.SPI and frozen modules.
There were a few modules that don't have docs (_asyncio for example), and one frozen module (adafruit_connection_manager) that doesn't follow the expected path (it's just connectionmanager), but ignoring that it's working well.

Context from discord:

I was going to add the links to the modules lists on boards pages (after imaginging they existed earlier 😁 ). I've got that sorted but the frozen modules are more tricky, mainly removing adafruit_ from the name and sticking after https://docs.circuitpython.org/projects/ works, e.g. https://docs.circuitpython.org/projects/display_text but not for connection_manager as it's page is without the underscore. Can RTD do aliases to fix that or do I need a more cunning plan?

Tested on the pico page (for normal modules), and pyportal (for frozen modules)

Copy link
Copy Markdown
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neat! Thank you!

@tannewt tannewt merged commit fadcf94 into main Aug 19, 2024
@dhalbert dhalbert deleted the turn-libraries-into-links branch August 22, 2024 16:05
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

Successfully merging this pull request may close these issues.

2 participants