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

pkg dev: devel help page does not open

Open pat-s opened this issue 5 years ago • 9 comments

When developing a package and calling devtools::load_all() and afterwards trying to open the help page of a function, the webview does not open.

devtools::load_all()
?<fun>
Rendering development documentation for '<fun>'

does not work while

library(<pkg>)
?<fun>

works.

pat-s avatar Jul 18 '20 20:07 pat-s

Thanks for reporting! I could reproduce this. It looks like this is caused by the development documentation is calling browser() with an html file while rendered documentation is calling browser() with an http web address.

Currently, the browser function vscode-R provides only works with a localhost http web address. And .vsc.viewer to view the htmlwidgets could be used to show such HTML file in a WebView as I tried, but all the paths in the HTML must be substituted with vscode-resource:// to work in WebView or the resource would not work.

And the theming does not look good under dark theme.

image

I'll think about this problem and see if we could find a nice solution. Suggestions are welcome.

renkun-ken avatar Jul 19 '20 02:07 renkun-ken

This is actually quite the issue for me as I am currently reworking the documentation of a package and this makes it difficult to do that in vsc while it would be much easier in rstudio. I am not sure if I can contribute anything as far as a solution goes but I will have a look!

assignUser avatar Aug 12 '20 11:08 assignUser

@renkun-ken Has there been any progress on this in the meantime?

pat-s avatar Feb 15 '21 21:02 pat-s

This issue is stale because it has been open for 365 days with no activity.

github-actions[bot] avatar Jun 09 '22 02:06 github-actions[bot]

Unstale

pat-s avatar Jun 09 '22 05:06 pat-s

This issue is stale because it has been open for 365 days with no activity.

github-actions[bot] avatar Jun 12 '23 02:06 github-actions[bot]

@pat-s Does #1259 help resolve the problem? The help pages could show development version of help pages in an editor tab, just like help pages.

renkun-ken avatar Jun 12 '23 06:06 renkun-ken

Nice, that sounds like a great solution!

assignUser avatar Jun 13 '23 03:06 assignUser