339c0f9a62
### What changes were proposed in this pull request? This PR adds a doc builder for Spark SQL's configuration options. Here's what the new Spark SQL config docs look like ([configuration.html.zip](https://github.com/apache/spark/files/4172109/configuration.html.zip)): ![Screen Shot 2020-02-07 at 12 13 23 PM](https://user-images.githubusercontent.com/1039369/74050007-425b5480-49a3-11ea-818c-42700c54d1fb.png) Compare this to the [current docs](http://spark.apache.org/docs/3.0.0-preview2/configuration.html#spark-sql): ![Screen Shot 2020-02-04 at 4 55 10 PM](https://user-images.githubusercontent.com/1039369/73790828-24a5a980-476f-11ea-998c-12cd613883e8.png) ### Why are the changes needed? There is no visibility into the various Spark SQL configs on [the config docs page](http://spark.apache.org/docs/3.0.0-preview2/configuration.html#spark-sql). ### Does this PR introduce any user-facing change? No, apart from new documentation. ### How was this patch tested? I tested this manually by building the docs and reviewing them in my browser. Closes #27459 from nchammas/SPARK-30510-spark-sql-options. Authored-by: Nicholas Chammas <nicholas.chammas@liveramp.com> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
56 lines
1.7 KiB
Bash
Executable file
56 lines
1.7 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright ownership.
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
# (the "License"); you may not use this file except in compliance with
|
|
# the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
|
|
# Script to create SQL API and config docs. This requires `mkdocs` and to build
|
|
# Spark first. After running this script the html docs can be found in
|
|
# $SPARK_HOME/sql/site
|
|
|
|
set -o pipefail
|
|
set -e
|
|
|
|
FWDIR="$(cd "`dirname "${BASH_SOURCE[0]}"`"; pwd)"
|
|
SPARK_HOME="$(cd "`dirname "${BASH_SOURCE[0]}"`"/..; pwd)"
|
|
|
|
if ! hash python 2>/dev/null; then
|
|
echo "Missing python in your path, skipping SQL documentation generation."
|
|
exit 0
|
|
fi
|
|
|
|
if ! hash mkdocs 2>/dev/null; then
|
|
echo "Missing mkdocs in your path, trying to install mkdocs for SQL documentation generation."
|
|
pip install mkdocs
|
|
fi
|
|
|
|
pushd "$FWDIR" > /dev/null
|
|
|
|
rm -fr docs
|
|
mkdir docs
|
|
|
|
echo "Generating SQL API Markdown files."
|
|
"$SPARK_HOME/bin/spark-submit" gen-sql-api-docs.py
|
|
|
|
echo "Generating SQL configuration table HTML file."
|
|
"$SPARK_HOME/bin/spark-submit" gen-sql-config-docs.py
|
|
|
|
echo "Generating HTML files for SQL API documentation."
|
|
mkdocs build --clean
|
|
rm -fr docs
|
|
|
|
popd
|