'pkgdown' для нескольких пакетов - PullRequest
0 голосов
/ 02 июня 2018

Наша группа публикует пакеты R (для внутреннего использования) в CRAN-подобном хранилище.Пользователи жаловались (справедливо) на то, что документация для них не очень доступна без запуска R и выполнения ?function_name в интерактивном режиме.

Поэтому я хотел бы создать веб-сайт с документацией для всех версийПакеты R, созданные моей группой.

Если я сделаю pkgdown::build_site() в каталоге верхнего уровня моего пакета, это создаст красивое автономное дерево docs/, содержащее файлы HTML со всеми документами для этого пакета.У него даже есть выдающийся номер версии в верхней части каждой страницы, что приятно.

Теперь я хотел бы разместить это дерево документов на более крупном сайте, чтобы пользователь мог перейти к пакету, который он "ищите, посмотрите на предыдущие версии и т. д. Это то, для чего кто-то создал решение?

Я думаю, что каталог docs/ может быть просто rsync 'd для веб-сервера,построение пути из информации в DESCRIPTION, например:

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, будет использовать все, что подходит)?

...