../_images/kyuubi_logo_simple6.png

3. Building Kyuubi Documentation

Follow the steps below and learn how to build the Kyuubi documentation as the one you are watching now.

3.1. Install & Activate virtualenv

Firstly, install virtualenv, this is optional but recommended as it is useful to create an independent environment to resolve dependency issues for building the documentation.

pip install virtualenv

Switch to the docs root directory.

cd $KTUUBI_HOME/docs

Create a virtual environment named ‘kyuubi’ or anything you like using virtualenv if it’s not existing.

virtualenv kyuubi

Activate it,

 source ./kyuubi/bin/activate

3.2. Install all dependencies

Install all dependencies enumerated in the requirements.txt

pip install -r requirements.txt

3.3. Create Documentation

make html

If the build process succeed, the HTML pages are in _build/html.

3.4. View Locally

Open the _build/html/index.html file in your favorite web browser.