Skip to content

GH-537: [Release][Docs] Generate API reference - #538

Merged
kou merged 14 commits into
apache:mainfrom
kou:docs
Jan 20, 2025
Merged

GH-537: [Release][Docs] Generate API reference#538
kou merged 14 commits into
apache:mainfrom
kou:docs

Conversation

@kou

@koukou commented Jan 20, 2025

Copy link
Copy Markdown
Member

The followings are out-of-scope:

The followings are out-of-scope:
* Generate Sphinx based documents
* Publish this to https://arrow.apache.org/java/reference/ in release
process
* Publish this to https://arrow.apache.org/dev/reference/ nightly

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this build the docs for the JNI components too? Or do we need to enable the JNI build to get the Javadocs?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this build the docs for the JNI components too?

No.

Or do we need to enable the JNI build to get the Javadocs?

Yes. But it's easy because we already have JNI enabled jobs. I'll do it.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought we can use docker compose run vcpkg-jni but it doesn't create JAR. So I can't use it for mvn site.
I used ci/scripts/jni_full_build.sh instead.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, vcpkg-jni only builds the shared object and not the full package

Comment threadci/scripts/build.sh
Comment on lines +62 to +65
# TODO: ARROW_JAVA_SHADE_FLATBUFFERS isn't used for our artifacts. Do
# we need this?
# See also: https://github.com/apache/arrow/issues/22021
if [ "${ARROW_JAVA_SHADE_FLATBUFFERS:-OFF}" == "ON" ]; then

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to revisit this sometime because of #67 (and it appears Google has closed the issue asking them to fix it upstream).

AFAIK the discussion in the issue you found is weird...We shouldn't need to change imports ourselves, the shading should take care of that. But that's not relevant here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Can we use #67 for this topic? Or should we create a separated issue for this topic?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can use #67!

@lidavidm

Copy link
Copy Markdown
Member

BTW, I will try to migrate the Sphinx docs when I get a chance

@kou

kou commented Jan 20, 2025

Copy link
Copy Markdown
MemberAuthor

I confirmed that release-docs includes API reference for JNI such as C and Gandiva: https://github.com/apache/arrow-java/actions/runs/12863727769?pr=538#artifacts

@kou
kou merged commit 1960085 into apache:mainJan 20, 2025
@kou
kou deleted the docs branch January 20, 2025 11:14
@koukou linked an issue Jan 21, 2025 that may be closed by this pull request
@lidavidmlidavidm added this to the 18.2.0 milestone Jan 30, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Release][Docs] Generate API reference

2 participants

@kou@lidavidm