robotcode icon indicating copy to clipboard operation
robotcode copied to clipboard

[ENHANCEMENT] LibDoc HTML preview inside VsCode

Open Heck-R opened this issue 1 year ago • 1 comments

Is your enhancement request related to a problem? Please describe. Sometimes libraries have library-level documentation, and certain stuff are just easier search and see in the HTML output of libdoc. This is pretty much the only cool feature I sometimes temporarily switch to the other RoF lsp extension for

Describe the solution you'd like Some kind of tab in VsCode that can open a library's HTML documentation, including remote imports (as long as it's available at the time of course), when the library name in the import is clicked / right clicked with a menu option etc.

Describe alternatives you've considered

  • Running libdoc <library> "$env:TEMP/OnDemandLibDoc.html"; . "$env:TEMP/OnDemandLibDoc.html" with powershell via some shortcut, but specifying the lib and handling the additional browser window is annoying
  • Switching extensions back and forth :D

Additional context Example from the other extension: image

Heck-R avatar Sep 10 '24 12:09 Heck-R

it is supported!

  • right click on the name in a library, resource import
  • choose Source Action
  • choose Show Documentation

then a new window should open with the documentation of the library. In the upper right corner of this internal browser windows you can also open this help in an external browser.

This also works on every keyword definitions and calls.

there is another way to open this window. In the Explorer View there should be a Keywords View, here you can find all available libraries and keywords loaded in the current openen robot file. if you select here an item the you get some/a button on the left side of this item. Just click the Show Documentation button

https://github.com/user-attachments/assets/529af3c8-ebea-4ac8-85a2-e8b1864918bd

d-biehl avatar Sep 10 '24 14:09 d-biehl

Does that work for you?

d-biehl avatar Sep 11 '24 20:09 d-biehl

Oh, that's perfect, thanks! Apologies then, I guess this was a case of VSCode skill issue on my part 😅 I'll close this then, thanks again for the fast response 🙂

Heck-R avatar Sep 13 '24 11:09 Heck-R