-
- Downloads
[SPARK-21485][SQL][DOCS] Spark SQL documentation generation for built-in functions
## 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.
Showing
- .gitignore 2 additions, 0 deletions.gitignore
- docs/README.md 3 additions, 3 deletionsdocs/README.md
- docs/_layouts/global.html 1 addition, 0 deletionsdocs/_layouts/global.html
- docs/_plugins/copy_api_dirs.rb 27 additions, 0 deletionsdocs/_plugins/copy_api_dirs.rb
- docs/api.md 1 addition, 0 deletionsdocs/api.md
- docs/index.md 1 addition, 0 deletionsdocs/index.md
- sql/README.md 2 additions, 0 deletionssql/README.md
- sql/core/src/main/scala/org/apache/spark/sql/api/python/PythonSQLUtils.scala 7 additions, 0 deletions...cala/org/apache/spark/sql/api/python/PythonSQLUtils.scala
- sql/create-docs.sh 49 additions, 0 deletionssql/create-docs.sh
- sql/gen-sql-markdown.py 91 additions, 0 deletionssql/gen-sql-markdown.py
- sql/mkdocs.yml 19 additions, 0 deletionssql/mkdocs.yml
Loading
Please register or sign in to comment