lxorc 3203829f7d

[KYUUBI #3005 ] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation' part

### _Why are the changes needed?_
Correct spelling and smooth documentation make the community better.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3006 from lxorc/master.

Closes #3005

ca294af5 [lxorc] [DOCS] Correct spelling errors and optimizations in 'Building Kyuubi Documentation'

Authored-by: lxorc <13612100484@163.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>

2022-07-05 10:44:10 +08:00

1.9 KiB

Raw Blame History

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`

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 $KYUUBI_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_HOME/bin/activate

Install all dependencies

Install all dependencies enumerated in the requirements.txt.

pip install -r requirements.txt

Create Documentation

linux & macos

cd $KYUUBI_HOME
make html

windows

cd $KYUUBI_HOME
make.bat html

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

View Locally

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

1.9 KiB Raw Blame History