如何在Linux系统从源码构建Clang/LLVM文档？

1. 安装文档构建依赖 #

首先需要安装生成文档必需的工具，以Fedora为例：

dnf install doxygen graphviz python3-sphinx

这些工具的作用：

• doxygen：生成man手册和API文档
• graphviz：生成文档中的图形元素
• python3-sphinx：构建HTML格式的用户指南类文档

2. 重新配置CMake（添加文档构建选项） #

进入LLVM构建目录，重新运行CMake并开启文档相关开关，保留你之前的编译配置（比如CMAKE_INSTALL_PREFIX等）：

cmake -S /path/to/llvm/source -B /path/to/build/dir \
  -DLLVM_BUILD_DOCS=ON \
  -DCLANG_BUILD_DOCS=ON \
  -DLLVM_ENABLE_DOXYGEN=ON \
  -DLLVM_ENABLE_SPHINX=ON \
  -DLLVM_INSTALL_MAN_DIR=/usr/local/share/man \
  # 追加你原有的其他配置参数

关键选项说明：

• LLVM_BUILD_DOCS/CLANG_BUILD_DOCS：开启LLVM和Clang的文档构建
• LLVM_ENABLE_DOXYGEN：启用Doxygen生成man文件
• LLVM_INSTALL_MAN_DIR：指定man文件的安装路径（可根据需求修改）

3. 构建并安装文档 #

• 构建所有文档（包括man、HTML格式的指南和API文档）：

  make docs
  

• 仅构建man文件（节省时间）：

  make clang-man llvm-man
  

• 将生成的文档（包括man文件）安装到系统目录：

  make install-docs
  

4. 验证结果 #

安装完成后，直接运行man clang即可查看最新版本的Clang手册；未安装的话，可在构建目录的docs/man子目录下找到生成的man文件，用man ./docs/man/clang.1临时查看。

内容的提问来源于stack exchange，提问作者PRouleau