ropensci/docs

rOpenSci docs ![badge]([***]

镜像概述

本镜像为rOpenSci社区提供文档生成工具集，核心用于构建pkgdown格式的R包文档网站，支持从Git仓库或本地路径生成文档，并可将文档部署到GitHub，同时能配合Web服务器实现本地文档托管。

核心功能

1. 创建持久卷存储文档和源包数据
2. 从Git仓库URL或本地路径构建R包的pkgdown文档
3. 将生成的文档部署到GitHub（需提供GitHub个人访问令牌）
4. 配合Web服务器本地托管文档网站
5. 支持并行构建多个R包文档

使用场景

• R包开发者生成并本地预览包文档
• 团队协作中统一构建和部署R包文档到GitHub
• 本地搭建文档服务器用于内部文档查阅

配置说明

环境变量

• GITHUB_PAT：GitHub个人访问令牌，用于部署文档到GitHub，需具备目标仓库的写入权限
• GIT_USER：可选，提交文档时使用的Git用户名
• GIT_EMAIL：可选，提交文档时使用的Git***地址

部署示例

创建持久卷

首先创建持久卷data存储文档和源包：

bash
docker volume create data

本地托管文档

使用Web服务器容器托管data卷中的文档：

bash
docker run -d -p 80:8043 -v data:/srv/http --name httpd pierrezemb/gostatic

访问http://localhost即可查看文档。可通过以下命令停止/启动服务器：

bash
docker stop httpd
docker start httpd

构建文档

从Git仓库构建R包文档（支持并行执行）：

bash
docker run --rm -it -v data:/data ropensci/docs build https://github.com/jeroen/openssl
docker run --rm -it -v data:/data ropensci/docs build https://github.com/ropensci/magick

从本地路径构建文档：

bash
docker create --name builder --rm -it -v data:/data ropensci/docs build "/sources"
docker cp $PWD "builder:/sources"
docker start builder --attach

成功构建后，文档将保存到/data目录，可通过http://localhost/docs访问。

部署到GitHub

创建env.txt文件配置环境变量（示例内容）：

GITHUB_PAT=your_github_personal_access_token
GIT_USER=your_git_username
GIT_EMAIL=your_git_email@example.com

执行部署命令：

bash
docker run --rm -it --env-file=env.txt -v data:/data ropensci/docs deploy

清理资源

停止服务器并删除持久卷：

bash
docker stop httpd && docker rm httpd
docker volume rm data

Jenkins CI服务器配置

参考jenkins.md文档，使用Docker Compose搭建Jenkins服务器实现文档自动化构建。