docs: publish Javadoc as part of the User Guide#31
Merged
andygrove merged 5 commits intoMay 13, 2026
Conversation
ec38364 to
0f33cb9
Compare
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
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
The User Guide has no rendered API reference today. Readers can browse the
narrative pages but have to drop into source code to look up class and method
signatures.
What changes are included in this PR?
Generates Javadoc at docs build time and embeds it under
/api/in theSphinx output. A new "API Reference" page in the User Guide links into it.
pom.xml— addsmaven-javadoc-plugin3.11.2, configured to exclude thegenerated protobuf packages (
datafusion_common.*,org.apache.datafusion.protobuf.*) so the published reference only covershand-written API.
docs/build.sh— invokes./mvnw javadoc:javadocfrom the repo root andstages
target/reports/apidocs/intodocs/source/_extra/api/beforesphinx-buildruns.docs/source/conf.py— addshtml_extra_path = ["_extra"]so Sphinxcopies the staged tree verbatim into the output, plus
exclude_patterns = ["_extra"]so the Javadoc-emitted.mdfiles(
legal/jquery.md, etc.) aren't scanned as Sphinx sources under-W.docs/source/user-guide/api-reference.md— new page in the User Guidetoctree linking to
api/index.html. The link is a raw HTML anchor with acomment explaining why (MyST treats relative
.htmlMarkdown links ascross-references and fails the strict build).
.gitignore— ignores the new staging directory.docs/README.md— documents the new JDK + first-run network requirementfor the docs build.
Are these changes tested?
The docs build itself is the verification.
./docs/build.shnow produces asingle tree at
docs/build/html/containing the existing Sphinx pages plus/api/index.htmland the surrounding Javadoc, and exits 0 undersphinx-build -Wwith no warnings. The exclusion of generated protobufpackages is verified by directory absence checks in the build output.
Are there any user-facing changes?
Yes — the published User Guide gains an "API Reference" page and a
browsable Javadoc tree at
api/.