Skip to content

Commit

Permalink
[Docs] Minor update to docs build instructions (delta-io#3543)
Browse files Browse the repository at this point in the history
An additional step are needed to build the docs locally.
  • Loading branch information
vkorukanti authored Aug 13, 2024
1 parent 6bc1eb0 commit 7122c25
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ conda env create --name delta_docs --file=<absolute_path_to_delta_repo>/docs/env
### JDK Setup
API doc generation needs JDK 1.8. Make sure to setup `JAVA_HOME` that points to JDK 1.8.

### Set the Delta Lake version
Set the version of Delta Lake release these docs are being generated for.
```
export _DELTA_LAKE_RELEASE_VERSION_=3.3.0
```

### Generate docs
Run the command from the `delta` repo root directory:
```
Expand Down

0 comments on commit 7122c25

Please sign in to comment.