starlabio/doxygen

Doxygen自动化文档生成容器

镜像概述

本镜像提供一个简易的Doxygen容器化解决方案，旨在简化代码文档的自动化生成流程。基于Doxygen工具，通过容器化方式消除环境配置依赖，方便快速部署和集成到各类开发流程中。

核心功能与特性

• 轻量级设计：采用精简基础镜像，减少资源占用
• 工具集成：内置Doxygen文档生成工具，支持C/C++、Java、Python等多种编程语言
• 自动化支持：可直接执行文档生成命令，支持集成到自动化流程
• 配置兼容：完全兼容标准Doxygen配置文件(Doxyfile)，保留原生功能

使用场景与适用范围

• 开发团队代码文档的统一生成与管理
• CI/CD流水线中集成自动文档生成步骤
• 个人项目的快速文档生成需求
• 需要跨平台一致文档输出的场景

使用方法与配置说明

基本使用（docker run）

bash
docker run -v /本地代码目录:/code -v /输出文档目录:/docs doxygen-container doxygen /code/Doxyfile

参数说明：

• -v /本地代码目录:/code：挂载本地代码目录到容器内/code路径，需包含Doxyfile配置文件
• -v /输出文档目录:/docs：挂载本地目录用于接收生成的文档
• doxygen /code/Doxyfile：执行Doxygen命令，使用指定路径的配置文件

配置说明

Doxyfile配置

容器依赖标准Doxygen配置文件(Doxyfile)进行文档生成，主要配置项包括：

• INPUT：指定需要生成文档的源代码目录
• OUTPUT_DIRECTORY：指定文档输出路径（容器内建议设为/docs）
• GENERATE_HTML：是否生成HTML格式文档（默认YES）
• GENERATE_LATEX：是否生成LaTeX格式文档（默认YES）

示例：生成HTML文档

1. 在本地代码根目录创建Doxyfile，配置：

   INPUT = ./src
   OUTPUT_DIRECTORY = /docs
   GENERATE_HTML = YES
   GENERATE_LATEX = NO
   

2. 执行生成命令：

   bash
   docker run -v $(pwd):/code -v $(pwd)/docs:/docs doxygen-container doxygen /code/Doxyfile
   

3. 生成的HTML文档将保存在本地./docs/html目录下，可通过浏览器直接打开查看