dldl/sphinx-server

Sphinx-Server

Sphinx-Server是基于Alpine的Docker镜像，用于构建和服务Sphinx文档。

![Build Status]([] ![Docker layers]([]

核心功能

• 通过Python服务器提供Sphinx文档服务
• 支持PlantUML生成UML图
• 支持Graphviz的dot工具
• 内置sphinx-autobuild实现文档自动构建
• 支持HTTP认证

限制

• 镜像未捆绑LaTeX，但可生成.tex文件并在容器外编译

安装

从Docker Hub拉取

使用以下命令拉取镜像：

sh
docker pull dldl/sphinx-server

若仅需编译文档而不启动服务器，可在文档根目录执行：

sh
docker run -t -v "$(pwd)":/web dldl/sphinx-server make html

从源码构建

克隆仓库后构建镜像：

sh
git clone https://github.com/dldl/sphinx-server.git
cd sphinx-server
docker build -t dldl/sphinx-server .

使用场景

• 快速搭建Sphinx文档服务
• 开发阶段自动构建文档，实时预览变更
• 为文档添加HTTP认证保护

配置说明

可在项目文档根目录添加.sphinx-server.yml文件自定义配置（若无则使用默认配置）。如需启用HTTP认证，需在配置文件中添加credentials section，并将autobuild设为false。

容器创建

生产模式（无自动构建）

sh
docker run -itd -v "$(pwd)":/web -p 8000:8000 --name sphinx-server dldl/sphinx-server

自动构建模式（默认启用）

sh
docker run -itd -v "$(pwd)":/web -u $(id -u):$(id -g) -p 8000:8000 --name sphinx-server dldl/sphinx-server

服务器将监听8000端口，当前目录文件会挂载到容器内。

容器交互

• 停止服务器：docker stop sphinx-server
• 启动服务器：docker start sphinx-server
• 删除服务器：docker rm -v sphinx-server
• 进入容器终端：docker exec -it sphinx-server /bin/sh，可执行make html等命令构建文档。