GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/spark/pull/18702
[SPARK-21485][SQL][DOCS] SQL documentation generation for built-in functions
## What changes were proposed in this pull request?
This generates a documentation for SQL built-in functions.
One drawback is, this requires a proper build to generate built-in function
list.
Once it is built, it only takes few seconds by `sql/docs/create-docs.sh`.
Please see https://spark-test.github.io/sparksqldoc/ that I hosted to show
the output documentation.
There are few more works to be done in order to make the documentation
pretty, for example, separating `Arguments:` and `Examples:` but I guess this
should be done within `ExpressionDescription` and `ExpressionInfo` rather than
manually parsing it. I will fix these in a follow up.
## How was this patch tested?
Manually tested:
```
jekyll build
```
and
```
cd sql/docs
create-docs.sh
```
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/spark SPARK-21485
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/spark/pull/18702.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #18702
----
commit ea865295ef9327ac2482abd0fbaf49931ae29232
Author: hyukjinkwon <[email protected]>
Date: 2017-07-20T16:14:43Z
SQL documentation generation
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
