-
Notifications
You must be signed in to change notification settings - Fork 28.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SPARK-21485][SQL][DOCS] Spark SQL documentation generation for built-in functions #18702
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,6 +47,8 @@ dev/pr-deps/ | |
dist/ | ||
docs/_site | ||
docs/api | ||
sql/docs | ||
sql/site | ||
lib_managed/ | ||
lint-r-report.log | ||
log/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
#!/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 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, skipping SQL documentation generation." | ||
exit 0 | ||
fi | ||
|
||
# Now create the markdown file | ||
rm -fr docs | ||
mkdir docs | ||
echo "Generating markdown files for SQL documentation." | ||
"$SPARK_HOME/bin/spark-submit" gen-sql-markdown.py | ||
|
||
# Now create the HTML files | ||
echo "Generating HTML files for SQL documentation." | ||
mkdocs build --clean | ||
rm -fr docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# | ||
# 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. | ||
# | ||
|
||
import sys | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does it complicate things to put these files in some kind of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It should be pretty simple. Let me try. |
||
import os | ||
from collections import namedtuple | ||
|
||
ExpressionInfo = namedtuple("ExpressionInfo", "className usage name extended") | ||
|
||
|
||
def _list_function_infos(jvm): | ||
""" | ||
Returns a list of function information via JVM. Sorts wrapped expression infos by name | ||
and returns them. | ||
""" | ||
|
||
jinfos = jvm.org.apache.spark.sql.api.python.PythonSQLUtils.listBuiltinFunctionInfos() | ||
infos = [] | ||
for jinfo in jinfos: | ||
name = jinfo.getName() | ||
usage = jinfo.getUsage() | ||
usage = usage.replace("_FUNC_", name) if usage is not None else usage | ||
extended = jinfo.getExtended() | ||
extended = extended.replace("_FUNC_", name) if extended is not None else extended | ||
infos.append(ExpressionInfo( | ||
className=jinfo.getClassName(), | ||
usage=usage, | ||
name=name, | ||
extended=extended)) | ||
return sorted(infos, key=lambda i: i.name) | ||
|
||
|
||
def _make_pretty_usage(usage): | ||
""" | ||
Makes the usage description pretty and returns a formatted string. | ||
Otherwise, returns None. | ||
""" | ||
|
||
if usage is not None and usage.strip() != "": | ||
usage = "\n".join(map(lambda u: u.strip(), usage.split("\n"))) | ||
return "%s\n\n" % usage | ||
|
||
|
||
def _make_pretty_extended(extended): | ||
""" | ||
Makes the extended description pretty and returns a formatted string. | ||
Otherwise, returns None. | ||
""" | ||
|
||
if extended is not None and extended.strip() != "": | ||
extended = "\n".join(map(lambda u: u.strip(), extended.split("\n"))) | ||
return "```%s```\n\n" % extended | ||
|
||
|
||
def generate_sql_markdown(jvm, path): | ||
""" | ||
Generates a markdown file after listing the function information. The output file | ||
is created in `path`. | ||
""" | ||
|
||
with open(path, 'w') as mdfile: | ||
for info in _list_function_infos(jvm): | ||
mdfile.write("### %s\n\n" % info.name) | ||
usage = _make_pretty_usage(info.usage) | ||
extended = _make_pretty_extended(info.extended) | ||
if usage is not None: | ||
mdfile.write(usage) | ||
if extended is not None: | ||
mdfile.write(extended) | ||
|
||
|
||
if __name__ == "__main__": | ||
from pyspark.java_gateway import launch_gateway | ||
|
||
jvm = launch_gateway().jvm | ||
markdown_file_path = "%s/docs/index.md" % os.path.dirname(sys.argv[0]) | ||
generate_sql_markdown(jvm, markdown_file_path) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# 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. | ||
|
||
site_name: Spark SQL, Built-in Functions | ||
theme: readthedocs | ||
pages: | ||
- 'Functions': 'index.md' |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than
cd
, is it possible to generate the output directly intodocs/
somewhere? maybe I miss why that's hard. It would avoid creating more temp output dirs in thesql
folderThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I misunderstood your previous comments initially. It shouldn't be hard.
but other language API docs are, up to my knowledge, in separate directories and then copied into
docs/
later. I was thinking we could extend this further in the future (e.g., syntax documentation) and it could be easier to check doc output in a separate dir (actually, for me, I check other docs output in this way more often).