如何使用 Sphinx 构建 CMake 文档？答案

【问题标题】：How to build CMake documentation with Sphinx?如何使用 Sphinx 构建 CMake 文档？
【发布时间】：2014-10-20 11:43:26
【问题描述】：

查看 CMake 源代码后，我成功配置并构建了 CMake。但是我如何构建 CMake 的文档呢？我已经安装了 Sphinx。

没有像make doc 这样的目标，而且我必须在哪里调用哪个Sphinx 命令并不明显。我在 CMake Wiki 或他们的邮件列表档案中没有找到任何提示。

【问题讨论】：

如果您使用 CMake 构建 CMake，您需要将 BUILD_DOCUMENTATION 变量设置为 TRUE。检查cmake-gui 或ccmake。另外，我将投票结束这个问题，因为它非常狭窄，应该在 CMake 邮件列表中询问。
这个问题似乎跑题了，因为它是关于 CMake 项目的构建系统，对于 StackOverflow 来说太窄了

【解决方案1】：

最近找到了答案[1]

使用 -DSPHINX_HTML=ON 配置 CMake。确保你有 python-sphinx 安装。将SPHINX_EXECUTABLE 指向sphinx-build 命令如果需要。

运行make。文档建在目录Utilities/Sphinx/html。

[1] 由 CMake 开发者 Brad King 在 CMake 开发者邮件列表中撰写，https://cmake.org/pipermail/cmake-developers/2015-September/026567.html。

【讨论】：

谢谢。只是想补充一点，添加的结果/新构建目标名为documentation，结果输出到相对于二进制输出目录的Utilities/Sphinx/html 目录。