timsaucer commented on PR #1161: URL: https://github.com/apache/datafusion-python/pull/1161#issuecomment-2992538234
This is good, but I still see a couple of issues when I build it locally. In the screen shot I am getting two different "API Reference" sections. <img width="371" alt="Screenshot 2025-06-20 at 2 32 27 PM" src="https://github.com/user-attachments/assets/aed278ef-04c8-48bf-a52e-d0e8e6f0f8cc"; /> I think that if we move this section to the end of the entry point it will collapse down to one part. `auto-api` I believe is appending to the index at the end. ``` .. _toc.api: .. toctree:: :hidden: :maxdepth: 1 :caption: API api/dataframe ``` *But* I think there is a more fundamental re-ordering we should do. Even if we move the snippet above to the bottom of the entry point we still have 1. "User Guide -> DataFrames" a page that has a very brief section about DataFrames and then a lot of information about formatting. 2. "User Guide -> DataFrames -> HTML Rendering in Jupyter" additional, and more detailed information about html rendering 3. "API -> DataFrame API" a page with some general usage patterns of DataFrames. In terms of this numbered list, I think it would be easier to understand/follow if we - Move the formatting information from (1) into (2) - Move the content of (3) into (1) and delete file (3) Then for the two pages, review to see if the flow of the information is clear. I suspect there would be some cleanup or deduplication we would want to do. What do you think? -- 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: github-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
