lukeelten/s2i-sphinx-doc-container

Sphinx文档OpenShift Source-to-Image容器镜像

镜像概述

本镜像结合OpenShift的Source-to-Image（S2I）机制与Sphinx文档生成工具，可快速将文档源代码转换为可部署的Web服务镜像，适用于开发团队自动化构建和发布项目文档。

核心功能

1. 支持S2I流程从文档源码构建镜像
2. 自定义文档访问路径、构建目标格式等环境变量
3. 集成Read The Docs主题配置能力
4. 提供本地调试与测试脚本
5. 兼容OpenShift平台部署流程

使用场景

• 开发团队快速生成并部署项目技术文档
• OpenShift平台上的文档自动化构建与发布
• 本地文档开发与预览验证

配置说明

环境变量

可通过.s2i/environment文件或容器运行时设置以下变量：

• PIP_INDEX_URL：自定义Python包索引地址，用于下载依赖包
• CONTEXT_PATH：文档Web服务的访问路径前缀（默认：/）
• MAKE_TARGET：Sphinx文档构建目标格式（默认：html）

部署示例

构建Docker镜像

bash
docker build -t iconoeugen/s2i-sphinx-doc .

快速测试

1. 设置环境变量：

bash
export CONTEXT_PATH=/
export MAKE_TARGET=html

2. 使用S2I构建示例应用：

bash
s2i build https://github.com/iconoeugen/s2i-sphinx-doc-container.git --context-dir=test/test-app -e MAKE_TARGET=${MAKE_TARGET} iconoeugen/s2i-sphinx-doc sphinx-doc-sample-app

3. 运行测试容器：

bash
docker run -p 8080:8080 -e CONTEXT_PATH=${CONTEXT_PATH} docker.xuanyuan.run/sphinx-doc-sample-app

4. 访问文档：

bash
curl http://127.0.0.1:8080/${CONTEXT_PATH}

OpenShift部署

1. 创建镜像流：

bash
oc create -f openshift/image-stream.json -n openshift

2. 上传应用模板：

bash
oc create -f openshift/template.json