consolidate datafusion docs with sphinx #993
Merged
Conversation
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
github-actions
bot
added
datafusion
houqp
requested review from
andygrove,
Dandandan,
jorgecarleitao and
nevi-me
|
I believe this is the last missing piece before we can prepare for the 5.1.0 release. |
houqp
force-pushed
the
qp_df_docs
branch
2 times, most recently
from
00f24ab to
51ed30a
Compare
* added python doc * combined, cli, user-guide and specification docs into a single datafusion doc Co-authored-by: Jiayu Liu <Jimexist@users.noreply.github.com>
houqp
commented
Sep 13, 2021
| @@ -0,0 +1,38 @@ | |||
| # Licensed to the Apache Software Foundation (ASF) under one | |||
houqp
commented
Sep 13, 2021
| @@ -0,0 +1,52 @@ | |||
| @rem Licensed to the Apache Software Foundation (ASF) under one | |||
houqp
commented
Sep 13, 2021
| @@ -0,0 +1,93 @@ | |||
| /** | |||
houqp
commented
Sep 13, 2021
| @@ -0,0 +1,19 @@ | |||
|
|
|||
|
@jimexist since you put in a lot of efforts into building out the python doc, do you mind taking a look at this PR? |
jimexist
reviewed
Sep 14, 2021
jimexist
approved these changes
Sep 14, 2021
|
generally LGTM, i might want to improve on the |
|
i think that #977 can go after you merge this - which i'll try to update |
Dandandan
approved these changes
Sep 14, 2021
|
🎉 📖 |
andygrove
pushed a commit
to andygrove/datafusion
that referenced
this pull request
Jan 31, 2025
* Start working on GetArrayStructFIelds * Almost have working * Working * Add another test * Remove unused * Remove unused sql conf
unkloud
pushed a commit
to unkloud/datafusion
that referenced
this pull request
Mar 23, 2025
* Start working on GetArrayStructFIelds * Almost have working * Working * Add another test * Remove unused * Remove unused sql conf
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Co-authored-by: Jiayu Liu Jimexist@users.noreply.github.com
Which issue does this PR close?
Closes #837
Closes #18
Relates to #18
Rationale for this change
This PR builds on top of the great work @jimexist did with our Python binding doc.
In summary, the suggestion from the arrow PR was to host the Python binding doc in our a website dedicated to datafusion instead of in Arrow's documentation page. Then link to the Datafusion documentation from Arrow home page's top banner.
Following the plan outlined at apache/arrow#10982 (comment), this PR consolidates all docs into a single doc website so we can use it as the home page for Datafusion (to be hosted at https://arrow.apache.org/datafusion). The Python binding doc prepared by @jimexist will be hosted as one of the sections in the Datafusion doc.
Once this PR is merged, I will generate the docs and send the full html build as a PR to the arrow-site repo.
What changes are included in this PR?
Are there any user-facing changes?
No
Here is what the documentation looks like: