yaooqinn opened a new pull request, #53829:
URL: https://github.com/apache/spark/pull/53829

   ### What changes were proposed in this pull request?
   
   This PR enhances the SQL function documentation generation by reorganizing 
built-in functions into categories for better navigation and discoverability.
   
   **Key changes:**
   - Group functions by category (aggregate, window, collection, string, 
datetime, math, etc.)
   - Generate separate markdown files for each category instead of a single 
large file
   - Auto-generate `mkdocs.yml` with navigation structure based on discovered 
categories
   - Add responsive grid layout for the function index page
   - Handle special characters in function names (e.g., `!`, `<`, `>`, `||`) 
for valid HTML anchors
   - Support group merges (e.g., `lambda_funcs` merged into `collection_funcs` 
per SPARK-45232)
   - Move `mkdocs.yml` to `.gitignore` since it's now auto-generated
   
   **Before:** All ~300+ functions listed in a single monolithic markdown file  
   **After:** Functions organized by category with dedicated pages and an 
overview index
   
   ### Why are the changes needed?
   
   The current documentation lists all built-in functions in a single, very 
long markdown file which makes it difficult to:
   - Find specific functions quickly
   - Browse functions by category
   - Maintain as new functions are added
   - Navigate on mobile devices
   
   This categorization improves user experience by organizing functions 
logically and making the documentation more maintainable.
   
   ### Does this PR introduce any user-facing change?
   
   Yes, the SQL function documentation structure changes from a single page to 
multiple category pages. Users will see:
   - An index page with functions grouped by category
   - Separate pages for each function category
   - Improved navigation with MkDocs sidebar
   - Responsive grid layout for better mobile experience
   
   ### How was this patch tested?
   
   - [x] Verified documentation generation runs without errors
   - [x] Reviewed generated markdown files for correct categorization
   - [x] Tested anchor links for special character function names
   - [x] Verified mkdocs.yml is correctly auto-generated
   - [x] Checked that all functions are included (no functions lost)
   
   ### Was this patch authored or co-authored using generative AI tooling?
   
   Yes, GitHub Copilot was used to assist with code development.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to