Add DataFrame API Documentation for DataFusion Python#1132
Merged
timsaucer merged 9 commits intoapache:mainfrom Jun 13, 2025
Merged
Add DataFrame API Documentation for DataFusion Python#1132timsaucer merged 9 commits intoapache:mainfrom
timsaucer merged 9 commits intoapache:mainfrom
Conversation
Contributor
|
As a user, these docs seem great! Looking forward to have them merged! |
Contributor
Author
|
this is ready for review |
timsaucer
reviewed
Jun 2, 2025
Member
timsaucer
left a comment
timsaucer
left a comment
There was a problem hiding this comment.
At a high level, this looks fantastic. I am getting a few errors when I try to build documentation locally. Are you able to run the ./docs/build.sh script without error?
|
|
||
| df = ctx.table("your_table") | ||
|
|
||
| * From various data sources: |
Member
There was a problem hiding this comment.
It might be nice to cross reference to the io pages.
timsaucer
approved these changes
Jun 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
This PR introduces comprehensive documentation for the
DataFrameAPI in DataFusion's Python library, including how to create, transform, and render DataFrames, especially in rich environments like Jupyter notebooks. It helps users better understand and utilize the powerful features of theDataFrameclass, including HTML rendering customization options.What changes are included in this PR?
Added a new API reference page:
docs/source/api/dataframe.rstthat covers:collect,to_pandas,show, etc.)Added a new API index page at
docs/source/api/index.rstand updated the Sphinx TOC inindex.rstto include it.Updated
conf.pyto exclude certain module-level docs from auto-generation.Minor formatting fix to a header in
functions.rst.Minor indentation correction in
dataframe.rstunder "Performance Optimization with Shared Styles".Are these changes tested?
These changes pertain to documentation and do not include functional code. Validation is done via manual Sphinx doc builds. Existing unit tests for the related Python functionality remain unchanged.
Are there any user-facing changes?
Yes, new user-facing documentation is added under the API Reference section, offering detailed guidance and examples for using
DataFrameand customizing HTML rendering in notebook environments. This enhances developer experience and usability.