构建文档

构建文档

按照以下步骤操作，了解如何构建出你正在阅读的这份 Kyuubi 文档。

搭建环境

• 首先，安装 virtualenv，这一步是可选的，但建议执行，因为它有助于创建一个独立的环境，从而解决构建文档时的依赖问题。

安装 virtualenv

$ pip install virtualenv

• 切换到 docs 根目录。

切换到 docs

$ cd $KYUUBI_SOURCE_PATH/docs

• 使用 virtualenv 创建一个名为 kyuubi（或你喜欢的任何名称）的虚拟环境，如果它尚不存在的话。

新建虚拟环境

$ virtualenv kyuubi

• 激活虚拟环境，

激活虚拟环境

$ source ./kyuubi/bin/activate

安装所有依赖

安装 requirements.txt 中列出的所有依赖。

安装依赖

$ pip install -r requirements.txt

创建文档

请确保你位于 $KYUUBI_SOURCE_PATH/docs 目录下。

Linux 与 MacOS

在类 Unix 操作系统上使用 Sphinx 构建

$ make html

Windows

在 Windows 上构建 Sphinx 文档

$ make.bat html

如果构建成功，HTML 页面位于 $KYUUBI_SOURCE_PATH/docs/_build/html。

本地查看

在您常用的网络浏览器中打开 $KYUUBI\_SOURCE\_PATH/docs/\_build/html/index.html 文件。