注意
本文档适用于 Ceph 开发版本。
构建Ceph文档
Ceph使用Python的Sphinx文档工具。有关Sphinx文档工具的详细信息，请参阅Sphinx文档工具.
要构建Ceph文档集，您必须：
克隆Ceph仓库
安装所需工具
构建文档
演示文档（可选）
克隆Ceph仓库
要克隆Ceph仓库，您必须在您的本地主机上安装git。要安装git，执行：
sudo apt-get install git
要克隆Ceph仓库，执行：
git clone git://github.com/ceph/ceph
您应该有一个完整的Ceph仓库副本。
安装所需工具
要构建Ceph文档，需要一些依赖项。要知道需要哪些软件包，您可以运行此命令：
cd ceph
admin/build-doc
如果依赖项缺失，上述命令将失败，并显示一条建议您安装所有缺失依赖项的命令的消息。
构建文档
安装完所有依赖项后，执行构建（与上述相同的命令）：
cd ceph
admin/build-doc
构建文档集后，您可以导航到源目录查看它：
cd build-doc/output
应该有一个html目录和一个man目录，其中包含HTML和manpage格式的文档。
admin/build-doc准备环境和构建文档需要很长时间。但是，您可以使用以下命令在更改时重新构建文档：
admin/build-doc livehtml
此功能使用sphinx-autobuild在底层工作。您也可以传递选项给它。例如，要在构建文档后打开浏览器：
admin/build-doc livehtml -- --open-browser
请参阅sphinx-autobuild for more details.
演示文档
如上所述构建文档后，您可以通过运行serve-doc:
cd ceph
admin/serve-doc
来演示渲染的文档build-doc/output/html目录，通过端口8080，使用Python的SimpleHTTPServer模块。
由 Ceph 基金会带给您
Ceph 文档是一个社区资源，由非盈利的 Ceph 基金会资助和托管Ceph Foundation. 如果您想支持这一点和我们的其他工作，请考虑加入现在加入.