jvzantvoort/sbimage

镜像概述和主要用途

该镜像主要用于处理gitlab-ci和sphinx-doc内容，提供构建sphinx-doc文档的基础环境，支持通过Docker容器快速执行文档构建流程。

核心功能和特性

• 支持挂载本地代码目录与输出目录，实现文档源文件读取和构建结果输出
• 包含entrypoint.sh脚本，用于执行文档构建任务
• 依赖标准sphinx-doc目录结构，需包含config.py配置文件及文档源文件

使用场景和适用范围

适用于需要通过Docker容器构建sphinx-doc文档的场景，尤其适合集成到gitlab-ci等持续集成流程中，实现文档的自动化构建与管理。

使用方法和配置说明

基本使用命令

bash
docker run --rm --name foo -v $PWD:/code -v $HOME/tmp/output:/output -t jvzantvoort/sbimage:2 ./entrypoint.sh $(id -u) $(id -g)

参数说明

• --rm: 容器退出后自动删除容器
• --name foo: 指定容器名称为foo
• -v $PWD:/code: 将当前工作目录挂载到容器内的/code目录，用于提供sphinx-doc源文件
• -v $HOME/tmp/output:/output: 将本地输出目录挂载到容器内的/output目录，用于存放构建结果
• -t jvzantvoort/sbimage:2: 指定使用的镜像及标签
• ./entrypoint.sh $(id -u) $(id -g): 执行容器内的entrypoint.sh脚本，并传入当前用户的UID和GID

环境要求

• 本地需存在sphinxdoc目录，且该目录下必须包含sphinx-doc所需的config.py配置文件和文档源文件
• 确保挂载的代码目录（/code）包含sphinxdoc目录，以便容器内脚本正确识别文档源