databricksdocs/sphinx

Databricks Sphinx 镜像

镜像概述

Databricks Sphinx镜像是用于构建Databricks文档的Sphinx构建环境，包含构建Databricks文档所需的Dockerfile及相关配置文件。该镜像为文档构建提供标准化环境，确保文档构建过程的一致性和可重复性。

核心功能和特性

• 提供完整的Sphinx文档构建环境，支持Databricks文档的编译和生成
• 遵循语义化版本控制（semantic versioning），便于版本管理和追踪
• 支持快速修改机制，可在不重新构建完整镜像的情况下调整环境配置
• 提供标准化的构建流程，确保文档构建过程的一致性

使用场景

• Databricks文档的日常构建和维护工作
• 文档构建环境的版本管理和更新
• 需要临时调整构建环境配置的开发场景
• 文档构建流程的标准化和自动化部署

使用方法

镜像构建流程

从https://github.com/databricks/docs%E4%BB%93%E5%BA%93%E7%9A%84%E6%A0%B9%E7%9B%AE%E5%BD%95%E5%BC%80%E5%A7%8B%EF%BC%8C%E5%A3%B0%E6%98%8E%E8%A6%81%E6%9E%84%E5%BB%BA%E7%9A%84%E5%AE%B9%E5%99%A8%E7%89%88%E6%9C%AC%EF%BC%8C%E7%84%B6%E5%90%8E%E6%89%A7%E8%A1%8C%E6%9E%84%E5%BB%BA%E5%91%BD%E4%BB%A4%EF%BC%9A

1. 设置镜像版本（遵循语义化版本）：

   bash
   export IMAGE_VERSION=v0.0.4
   

2. 构建镜像：

   bash
   docker build -t databricksdocs/sphinx:${IMAGE_VERSION} -f shared/docker/sphinx/Dockerfile .
   

快速修改镜像

当需要对镜像进行临时修改且不想等待完整构建过程时，可按以下步骤操作：

1. 运行当前版本的镜像并进入交互模式：

   bash
   docker run --rm --name sphinx -it databricksdocs/sphinx:${IMAGE_VERSION} bash
   

2. 在容器内进行必要的修改后，提交为新的镜像版本（在现有版本号后添加小写字母）：

   bash
   docker commit -m "Updated sphinx image" sphinx databricksdocs/sphinx:${IMAGE_VERSION}a
   

3. 推送更新后的镜像：

   bash
   docker push databricksdocs/sphinx:${IMAGE_VERSION}a
   

版本管理说明

镜像版本号大致遵循语义化版本规范，版本更新时应根据变更的数量和深度递增相应的版本号部分（主版本、次版本或修订版本）。