Skip to content

Commit 25f6fcd

Browse files
committed
docs: add API Reference page to the User Guide
1 parent 0989960 commit 25f6fcd

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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+
<a href="../api/index.html"><strong>api/index.html</strong></a>.
24+
25+
The reference covers the `org.apache.datafusion` package, including
26+
`SessionContext`, `SessionContextBuilder`, `DataFrame`, `CsvReadOptions`,
27+
`ParquetReadOptions`, and `NativeLibraryLoader`, plus the
28+
`org.apache.datafusion.proto` helpers. Auto-generated protobuf classes are
29+
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)