Doxygen Awesome CSS 使用教程

最新推荐文章于 2024-12-10 09:24:53 发布

班歆韦Divine

最新推荐文章于 2024-12-10 09:24:53 发布

阅读量450

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00048/article/details/139670653

Doxygen Awesome CSS 使用教程

doxygen-awesome-css Custom CSS theme for doxygen html-documentation with lots of customization parameters. 项目地址: https://gitcode.com/gh_mirrors/do/doxygen-awesome-css

一、项目目录结构及介绍

doxygen-awesome-css 是一个专为 Doxygen HTML 文档设计的自定义CSS主题，提供了丰富的个性化设置选项。以下是该仓库的基本目录结构及其简介：

├── Doxyfile             # 示例Doxygen配置文件
├── LICENSE              # 许可证文件
├── Makefile             # 构建脚本，用于系统级安装
├── README.md            # 主要的项目说明文档
├── gitignore            # Git忽略文件配置
├── npmignore            # NPM发布时忽略的文件列表
├── package.json         # npm包配置文件
├── docs                 # 可能包含额外的文档或示例
├── img                  # 包含项目相关的图像文件
├── include/MyLibrary    # 示例代码文件或被文档化的库结构（非必需）
├── doxygen-awesome*.css # 主题CSS文件，包括基础样式和特定功能如侧边栏仅显示模式的CSS
└── doxygen-awesome*.js  # 提供额外JavaScript功能，如交互式目录等

每个以 doxygen-awesome- 开头的CSS和JS文件都是主题的重要组成部分，可以根据需求选择引入。

二、项目的启动文件介绍

这个项目没有传统意义上的“启动文件”，因为它主要是静态资源集合。但在使用此主题时，关键在于集成到Doxygen的构建流程中。通常，您不会直接“启动”这个项目，而是将它集成到自己的项目中，通过修改Doxygen的配置文件(Doxyfile)来应用这个主题。

三、项目的配置文件介绍

1. Doxyfile 配置

为了在您的Doxygen文档中应用这个主题，您需要在您的项目中的Doxyfile进行以下配置调整：

HTML_EXTRA_STYLESHEET：添加指向doxygen-awesome.css（以及如果使用侧边栏-only模式还需doxygen-awesome-sidebar-only.css）的路径。

HTML_EXTRA_STYLESHEET = path/to/doxygen-awesome-css/doxygen-awesome.css

如果启用侧边栏-only布局：

HTML_EXTRA_STYLESHEET = path/to/doxygen-awesome-css/doxygen-awesome.css \
                        path/to/doxygen-awesome-css/doxygen-awesome-sidebar-only.css

GENERATE_TREEVIEW：设置为YES以启用树状视图，这是主题推荐的配置。
```
GENERATE_TREEVIEW = YES
```
DISABLE_INDEX 和 FULL_SIDEBAR：依据所选布局（基础或侧边栏-only），适当设置这两个选项。

对于侧边栏-only模式：
```
DISABLE_INDEX = NO
FULL_SIDEBAR = NO
```
注意，HTML_COLORSTYLE 应设为 LIGHT 以兼容Doxygen 1.9.5及以上版本。