5b49061d86
### _Why are the changes needed?_ Add Docs for kyuubi tools spark-block-cleaner. * Explain the parameters * Introduction to basic startup * Give an example ### _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.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #815 from zwangsheng/doc/spark_block_cleaner. Closes #815 1ec6795f [Binjie Yang] delete todo bbf4d6e2 [Binjie Yang] make it common 9cf3e159 [Binjie Yang] format 0803995a [Binjie Yang] straighten out the article f834b382 [Binjie Yang] refactor 25be318f [Binjie Yang] fix 7304e595 [Binjie Yang] docs for spark-block-cleaner Authored-by: Binjie Yang <2213335496@qq.com> Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
56 lines
1.0 KiB
Markdown
56 lines
1.0 KiB
Markdown
<div align=center>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
# 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.
|
|
|
|
```bash
|
|
pip install virtualenv
|
|
```
|
|
|
|
Switch to the `docs` root directory.
|
|
|
|
```bash
|
|
cd $KTUUBI_HOME/docs
|
|
```
|
|
|
|
Create a virtual environment named 'kyuubi' or anything you like using `virtualenv` if it's not existing.
|
|
|
|
```bash
|
|
virtualenv kyuubi
|
|
```
|
|
|
|
Activate it,
|
|
|
|
```bash
|
|
source ./kyuubi/bin/activate
|
|
```
|
|
|
|
## Install all dependencies
|
|
|
|
Install all dependencies enumerated in the `requirements.txt`
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
## Create Documentation
|
|
|
|
```bash
|
|
make html
|
|
```
|
|
|
|
If the build process succeed, the HTML pages are in `_build/html`.
|
|
|
|
## View Locally
|
|
|
|
Open the `_build/html/index.html` file in your favorite web browser.
|