Skip to content

Commit 2bd94d0

Browse files
committed
Merge remote-tracking branch 'apache/main' into feat/examples-module
# Conflicts: # pom.xml
2 parents 6728113 + be10e16 commit 2bd94d0

6 files changed

Lines changed: 49 additions & 3 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ tpch-data/
88
.claude
99
docs/superpowers
1010
docs/build/
11+
docs/source/_extra/
1112
docs/venv/

‎docs/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@ documentation site.
2424

2525
## Build
2626

27-
Building the docs requires Python 3.9 or newer. A virtual environment under
28-
`docs/venv/` is the recommended workflow.
27+
Building the docs requires Python 3.9 or newer and a working `./mvnw` at the
28+
repo root (the build runs `./mvnw javadoc:javadoc` to generate the API
29+
reference, which also needs JDK 17 and one-time network access to fetch
30+
upstream `.proto` files). A virtual environment under `docs/venv/` is the
31+
recommended workflow.
2932

3033
```sh
3134
cd docs

‎docs/build.sh‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ set -e
2222
cd "$(dirname "$0")"
2323

2424
rm -rf build
25+
rm -rf source/_extra
26+
27+
# Generate Javadoc for the library module. javadoc:javadoc triggers
28+
# generate-sources, which fetches upstream protos via wget.
29+
(cd .. && ./mvnw -q -DskipTests -pl :datafusion-java javadoc:javadoc)
30+
31+
mkdir -p source/_extra
32+
cp -R ../core/target/reports/apidocs source/_extra/api
2533

2634
if [ -d venv ]; then
2735
# shellcheck disable=SC1091

‎docs/source/conf.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
}
3333

3434
templates_path = ["_templates"]
35-
exclude_patterns = []
35+
exclude_patterns = ["_extra"]
3636

3737
html_theme = "pydata_sphinx_theme"
3838
html_theme_options = {
@@ -48,6 +48,7 @@
4848
}
4949

5050
html_static_path = ["_static"]
51+
html_extra_path = ["_extra"]
5152

5253
# Auto-generate anchor links for headings h1, h2, h3.
5354
myst_heading_anchors = 3
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# API Reference
21+
22+
Generated Javadoc for the public Java API lives at
23+
<!-- Raw HTML link: MyST resolves relative .html Markdown links as
24+
cross-references, which fails sphinx-build -W. The Javadoc tree is
25+
copied verbatim via html_extra_path and is unknown to Sphinx. -->
26+
<a href="../api/index.html"><strong>api/index.html</strong></a>.
27+
28+
The reference covers the `org.apache.datafusion` package, including
29+
`SessionContext`, `SessionContextBuilder`, `DataFrame`, `CsvReadOptions`,
30+
`ParquetReadOptions`, and `NativeLibraryLoader`, plus the
31+
`org.apache.datafusion.proto` helpers. Auto-generated protobuf classes are
32+
intentionally excluded from the Javadoc — they are an implementation detail.

‎docs/source/user-guide/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ dataframe
3838
parquet
3939
proto-plans
4040
project-status
41+
api-reference
4142
```
4243

4344
> Early development: no releases yet, API will change. Bug reports and

0 commit comments

Comments
 (0)