FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: publish Javadoc as part of the User Guide by andygrove · Pull Request #31 · apache/datafusion-java · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .md  (3) .py  (1) .sh  (1) .xml  (1) dotfile  (1) All 5 file types selected
Only manifest files
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
1 change: 1 addition & 0 deletions .gitignore
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
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ tpch-data/
.claude
docs/superpowers
docs/build/
docs/source/_extra/
docs/venv/
7 changes: 5 additions & 2 deletions docs/README.md
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ documentation site.

## Build

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

```sh
cd docs
Expand Down
8 changes: 8 additions & 0 deletions docs/build.sh
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
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ set -e
cd "$(dirname "$0")"

rm -rf build
rm -rf source/_extra

# Generate Javadoc from the repo root. javadoc:javadoc triggers
# generate-sources, which fetches upstream protos via wget.
(cd .. && ./mvnw -q -DskipTests javadoc:javadoc)

mkdir -p source/_extra
cp -R ../target/reports/apidocs source/_extra/api

if [ -d venv ]; then
# shellcheck disable=SC1091
Expand Down
3 changes: 2 additions & 1 deletion docs/source/conf.py
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
}

templates_path = ["_templates"]
exclude_patterns = []
exclude_patterns = ["_extra"]

html_theme = "pydata_sphinx_theme"
html_theme_options = {
Expand All @@ -48,6 +48,7 @@
}

html_static_path = ["_static"]
html_extra_path = ["_extra"]

# Auto-generate anchor links for headings h1, h2, h3.
myst_heading_anchors = 3
Expand Down
32 changes: 32 additions & 0 deletions docs/source/user-guide/api-reference.md
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# API Reference

Generated Javadoc for the public Java API lives at
<!-- Raw HTML link: MyST resolves relative .html Markdown links as
cross-references, which fails sphinx-build -W. The Javadoc tree is
copied verbatim via html_extra_path and is unknown to Sphinx. -->
<a href="../api/index.html"><strong>api/index.html</strong></a>.

The reference covers the `org.apache.datafusion` package, including
`SessionContext`, `SessionContextBuilder`, `DataFrame`, `CsvReadOptions`,
`ParquetReadOptions`, and `NativeLibraryLoader`, plus the
`org.apache.datafusion.proto` helpers. Auto-generated protobuf classes are
intentionally excluded from the Javadoc — they are an implementation detail.
1 change: 1 addition & 0 deletions docs/source/user-guide/index.md
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
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ dataframe
parquet
proto-plans
project-status
api-reference
```

> Early development: no releases yet, API will change. Bug reports and
Expand Down
16 changes: 16 additions & 0 deletions pom.xml
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
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,22 @@ under the License.
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.11.2</version>
<configuration>
<source>17</source>
<failOnError>true</failOnError>
<failOnWarnings>false</failOnWarnings>
<doctitle>Apache DataFusion Java ${project.version}</doctitle>
<windowtitle>Apache DataFusion Java ${project.version}</windowtitle>
<links>
<link>https://docs.oracle.com/en/java/javase/17/docs/api/</link>
</links>
<excludePackageNames>datafusion_common:org.apache.datafusion.protobuf</excludePackageNames>
</configuration>
</plugin>
</plugins>
</build>
</project>
Loading

Back | FazBrowse Home | New Git URL