mghro/sphinx-aws-docker

sphinx-aws-docker镜像说明

镜像概述

本镜像基于https://github.com/plaindocs/docker-sphinx构建，集成了Ubuntu系统、Python3环境、Sphinx文档生成工具、LaTeX排版工具及AWS相关工具，旨在为用户提供一站式的Sphinx文档构建与AWS部署环境。

核心功能

1. 提供完整的Sphinx文档生成环境，支持多种格式输出（如HTML、PDF）
2. 集成LaTeX工具，满足复杂文档的排版需求
3. 包含AWS CLI等工具，可直接将生成的文档部署到AWS服务（如S3）
4. 基于Ubuntu系统，环境稳定且兼容性强

使用场景

1. 技术团队构建项目文档并自动化部署到AWS
2. 个人开发者生成高质量技术文档并存储到AWS云服务
3. 持续集成/持续部署（CI/CD）流程中嵌入文档构建与发布环节

配置说明

Docker Run示例

bash
docker run -v $(pwd)/docs:/docs docker.xuanyuan.run/mghro/sphinx-aws-docker sphinx-build -b html /docs/source /docs/build

上述命令将本地docs目录挂载到容器内，执行Sphinx构建命令生成HTML文档。

AWS部署示例

在容器内执行AWS CLI命令上传文档到S3：

bash
aws s3 sync /docs/build s3://your-bucket-name/docs --region cn-north-1

（需提前配置AWS凭证，可通过环境变量或挂载配置文件实现）

注意事项

• 使用前需确保已正确配置AWS访问权限（如通过AWS_ACCESS_KEY_ID和AWS_SECRET_ACCESS_KEY环境变量）
• 本地文档目录结构需符合Sphinx项目规范（包含source目录及conf.py文件）
• 生成PDF文档时需确保LaTeX环境依赖完整（镜像已预安装基础依赖）