riscvintl/riscv-docs-base-container-image

RISC-V文档构建基础容器镜像

镜像概述

本镜像为RISC-V文档构建提供标准化基础环境，集成文档生成所需的工具链和依赖项，旨在简化RISC-V文档的本地构建与自动化流程，避免因环境配置差异导致的构建问题。

核心功能与特性

• 预装文档构建工具：集成Sphinx、GNU Make、Python等文档生成核心工具
• RISC-V文档依赖：包含RISC-V文档项目特定的主题、插件及样式文件
• 环境一致性：标准化构建环境，确保不同场景下文档输出结果一致
• 轻量设计：基于精简基础镜像，减少资源占用，加速容器启动与构建过程

使用场景

• 文档贡献者：本地快速构建RISC-V文档预览修改效果
• CI/CD集成：嵌入自动化流程实现文档提交验证与版本发布
• 多版本管理：通过容器隔离不同文档版本的构建环境
• 新手友好：无需手动配置复杂依赖，开箱即可使用

使用方法与配置说明

基础构建命令

bash
docker run --rm -v /本地文档路径:/docs riscv-docs-base:latest make -C /docs html

• --rm：构建完成后自动清理容器
• -v /本地文档路径:/docs：将本地RISC-V文档源码目录挂载至容器内/docs路径
• riscv-docs-base:latest：镜像名称（具体标签需根据实际版本指定）
• make -C /docs html：执行文档构建命令，生成HTML格式输出

构建输出

构建产物默认位于挂载目录的_build/html子目录下，可通过本地浏览器直接打开index.html预览文档。

多格式支持

根据文档项目配置，支持生成多种格式输出：

bash
# 生成PDF格式（需文档项目支持）
docker run --rm -v /本地文档路径:/docs riscv-docs-base:latest make -C /docs pdf

# 生成EPUB格式
docker run --rm -v /本地文档路径:/docs riscv-docs-base:latest make -C /docs epub

注意事项

• 本地文档目录需包含完整的RISC-V文档项目结构（含Makefile及source目录）
• 首次运行可能因依赖下载导致构建时间较长，后续运行可复用缓存
• 镜像标签与RISC-V文档项目版本需匹配，避免工具版本兼容性问题