如何使用Sphinx构建CMake文档?

时间:2014-10-20 11:43:26

标签: documentation cmake python-sphinx

在查看CMake源之后,我成功配置并构建了CMake。但是我如何构建CMake的文档呢?我安装了Sphinx。

没有像make doc这样的目标,我不得不调用哪个Sphinx命令。我没有在CMake Wiki或他们的邮件列表档案中找到任何提示。

1 个答案:

答案 0 :(得分:5)

最近我找到了答案[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撰写。