rhene/sphinx-latexpdf

docker-sphinx-with-rtd-theme

镜像概述

本镜像基于sphinxdoc/sphinx-latexpdf构建（包含TeXLive包，镜像体积较大），额外添加了字体、工具及Python模块，增强了文档构建能力。

核心功能

1. 支持创建Sphinx项目模板
2. 生成HTML格式文档
3. 生成LaTeX PDF格式文档
4. 支持Markdown转文档（通过recommonmark等模块）
5. 集成Read the Docs主题

使用场景

• 技术文档编写与导出（如API手册、项目说明）
• 学术报告或手册的PDF生成
• 多格式文档统一构建流程

配置说明

1. 构建镜像

替换<your_tag>为自定义标签：

bash
docker build -t <your_tag> ./

2. 创建项目

替换</your/document/path>为文档目录：

bash
docker run -it --rm -v </your/document/path>:/docs <your_tag> sphinx-quickstart ./

3. 生成文档

• HTML文档：

  bash
  docker run --rm -v </your/document/path>:/docs <your_tag> make html
  

• PDF文档：

  bash
  docker run --rm -v </your/document/path>:/docs <your_tag> make latexpdf
  

部署示例

以rhene/sphinx-latexpdf标签为例：

bash
# 克隆仓库（可选）
git clone https://github.com/rhenerose/docker-sphinx-with-rtd-theme
cd docker-sphinx-with-rtd-theme

# 构建镜像
docker build -t rhene/sphinx-latexpdf ./

# 切换到项目目录
cd /your/document/path

# 生成HTML（Bash/PowerShell）
docker run --rm -v "$(pwd):/docs" rhene/sphinx-latexpdf make html

# 生成HTML（Windows cmd）
docker run --rm -v "%cd%:/docs" rhene/sphinx-latexpdf make html