vscode-circuitpython icon indicating copy to clipboard operation
vscode-circuitpython copied to clipboard

Add hotkey for opening a library's documentation on readthedocs.io

Open joedevivo opened this issue 5 years ago • 2 comments

Every library in the Adafruit bundle has docs up on readthedocs.io. We've already got hover docs, but you may want a more complete picture. Since I haven't figured out how to make a dash docset for the Adafruit bundle yet, this will be a good short term solution.

joedevivo avatar Mar 22 '20 14:03 joedevivo

There's a pretty specific transform to turn a CP library name into the stub that gets filled in to make the docs URL; basically downcase everything after Adafruit_CircuitPython_ so

Adafruit_CircuitPython_MSA301 => https://circuitpython.readthedocs.io/projects/msa301/en/latest/

There are some exceptions but that's a good 80% solution; I'm fairly certain that there is a programatic way of doing this but I'll have to refresh my memory

siddacious avatar Oct 31 '20 01:10 siddacious

I'd also like to request that Dash not be the primary way of linking to the docs since it appears to be closed source with no free option.

Of course this is your project so you can do as you wish, however it would be great for everyone to be able to use without being (in essence) behind a paywall

siddacious avatar Oct 31 '20 02:10 siddacious