' pkgdown'对于多个包

时间:2018-06-01 22:54:51

标签: r documentation pkgdown

我们的小组将R软件包(供内部使用)发布到类似CRAN的存储库。用户抱怨(正确地)他们无法访问文档,而无需启动R并以交互方式执行?function_name

所以我想建立一个网站,其中包含我的小组创建的R包的所有版本的文档。

如果我在我的软件包的顶级目录中pkgdown::build_site(),则会创建一个包含HTML文件的自包含树docs/,其中包含该软件包的所有文档。它甚至在每个页面的顶部都有一个醒目的版本号,这很不错。

现在我想将该文档树置于更大的网站中,以便用户可以浏览他们正在寻找的软件包,查看以前的版本等等。这是某人&#39 ; s为?

设置解决方案

我认为docs/目录可能只是rsync到网络服务器,从DESCRIPTION中的信息构建路径,例如:< / p>

Rscript -e 'pkgdown::build_site()'
mkdir -p r-docs/MyPackage        # Replace with real package name
mv docs r-docs/MyPackage/1.3.1   # Replace with real version
rsync -avz r-docs/ example.com:r-docs/

但这反复做起来有点尴尬 - 在pkgdown或其他类似软件包(不一定与pkgdown绑定)中对此用例有一些支持,会使用最多的内容吗?适当)?

0 个答案:

没有答案