60472dbfd9
## What changes were proposed in this pull request? This generates a documentation for Spark 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/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. This requires `pip install mkdocs` to generate HTMLs from markdown files. ## How was this patch tested? Manually tested: ``` cd docs jekyll build ``` , ``` cd docs jekyll serve ``` and ``` cd sql create-docs.sh ``` Author: hyukjinkwon <gurwls223@gmail.com> Closes #18702 from HyukjinKwon/SPARK-21485.
13 lines
377 B
Markdown
13 lines
377 B
Markdown
---
|
|
layout: global
|
|
title: Spark API Documentation
|
|
---
|
|
|
|
Here you can read API docs for Spark and its submodules.
|
|
|
|
- [Spark Scala API (Scaladoc)](api/scala/index.html)
|
|
- [Spark Java API (Javadoc)](api/java/index.html)
|
|
- [Spark Python API (Sphinx)](api/python/index.html)
|
|
- [Spark R API (Roxygen2)](api/R/index.html)
|
|
- [Spark SQL, Built-in Functions (MkDocs)](api/sql/index.html)
|