Building Kyuubi Documentation
Building Kyuubi Documentation#
Follow the steps below and learn how to build the Kyuubi documentation as the one you are watching now.
Install & Activate
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.
Create a virtual environment named ‘kyuubi’ or anything you like using
virtualenv if it’s not existing.
Install all dependencies#
Install all dependencies enumerated in the
pip install -r requirements.txt
Make sure you are in the
linux & macos
If the build process succeed, the HTML pages are in
$KYUUBI_SOURCE_PATH/docs/_build/html/index.html file in your favorite web browser.