Kent Yao e1921fc8c0

[KYUUBI #2751 ] [DOC] Replace sphinx_rtd_theme with sphinx_book_theme

### _Why are the changes needed?_

make documentation style to fit official web site

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

- [x] Add screenshots for manual tests if appropriate
![image](https://user-images.githubusercontent.com/8326978/170434595-d5ec5068-ab2d-484e-9371-9331311cc0f1.png)
- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2751 from yaooqinn/doc2.

Closes #2751

b8123525 [Kent Yao] Switch

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>

2022-05-27 02:22:36 +08:00

2.2 KiB

Raw Blame History

Developer Tools

Update Project Version


build/mvn versions:set -DgenerateBackupPoms=false

Update Document Version

Whenever project version updates, please also update the document version at docs/conf.py to target the upcoming release.

For example,

release = '1.2.0'

Update Dependency List

Kyuubi uses the dev/dependencyList file to indicate what upstream dependencies will actually go to the server-side classpath.

For Pull requests, a linter for dependency check will be automatically executed in GitHub Actions.

You can run build/dependency.sh locally first to detect the potential dependency change first.

If the changes look expected, run build/dependency.sh --replace to update dev/dependencyList in your Pull request.

Format All Code

Kyuubi uses Spotless with google-java-format and Scalafmt to format the Java and Scala code.

You can run dev/reformat to format all Java and Scala code.

Append descriptions of new configurations to settings.md

Kyuubi uses settings.md to explain available configurations.

You can run KYUUBI_UPDATE=1 build/mvn clean install -Pflink-provided,spark-provided,hive-provided -DwildcardSuites=org.apache.kyuubi.config.AllKyuubiConfiguration to append descriptions of new configurations to settings.md.

2.2 KiB Raw Blame History