[spark] branch master updated: [SPARK-34022][DOCS] Support latest mkdocs in SQL built-in function docs

[gu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

gurwls223 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new 0d86a02  [SPARK-34022][DOCS] Support latest mkdocs in SQL built-in function docs
0d86a02 is described below

commit 0d86a02ffbaf53c403a4c68bac0041e84acb0cdd
Author: HyukjinKwon <gu...@apache.org>
AuthorDate: Wed Jan 6 20:31:27 2021 +0900

    [SPARK-34022][DOCS] Support latest mkdocs in SQL built-in function docs
    
    ### What changes were proposed in this pull request?
    
    This PR adds the support of the latest mkdocs, and makes the sidebar properly show. It works in lower versions too.
    
    Before:
    
    ![Screen Shot 2021-01-06 at 5 11 56 PM](https://user-images.githubusercontent.com/6477701/103745131-4e7fe400-5042-11eb-9c09-84f9f95e9fb9.png)
    
    After:
    
    ![Screen Shot 2021-01-06 at 5 10 53 PM](https://user-images.githubusercontent.com/6477701/103745139-5049a780-5042-11eb-8ded-30b6f7ef48aa.png)
    
    ### Why are the changes needed?
    
    This is a regression in the documentation.
    
    ### Does this PR introduce _any_ user-facing change?
    
    Technically no. It's not related yet. It fixes the list on the sidebar appears properly.
    
    ### How was this patch tested?
    
    Manually built the docs via `./sql/create-docs.sh` and `open ./sql/site/index.html`
    
    Closes #31061 from HyukjinKwon/SPARK-34022.
    
    Authored-by: HyukjinKwon <gu...@apache.org>
    Signed-off-by: HyukjinKwon <gu...@apache.org>
---
 sql/gen-sql-api-docs.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/sql/gen-sql-api-docs.py b/sql/gen-sql-api-docs.py
index 6132899..7251850 100644
--- a/sql/gen-sql-api-docs.py
+++ b/sql/gen-sql-api-docs.py
@@ -195,6 +195,7 @@ def generate_sql_api_markdown(jvm, path):
     """
 
     with open(path, 'w') as mdfile:
+        mdfile.write("# Built-in Finctions\n\n")
         for info in _list_function_infos(jvm):
             name = info.name
             usage = _make_pretty_usage(info.usage)


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org