Ballista Documentation

User Documentation

Documentation for the current published release can be found at https://arrow.apache.org/ballista and the source content is located here.

Developer Documentation

Developer documentation can be found here.

Building the User Guide

Dependencies

It's recommended to install build dependencies and build the documentation inside a Python virtualenv.

• Python
• pip install -r requirements.txt
• DataFusion python package. You can install the latest version by running maturin develop inside ../python directory.

Build

./build.sh

Release

The documentation is served through the arrow-site repository. To release a new version of the documentation, follow these steps:

1. Download the release source tarball (we can only publish documentation from official releases)
2. Run ./build.sh inside docs folder to generate the docs website inside the build/html folder.
3. Clone the arrow-site repo
4. Checkout to the asf-site branch (NOT master)
5. Copy build artifacts into arrow-site repo's ballista folder with a command such as

• cp -rT ./build/html/ ../../arrow-site/ballista/ (doesn't work on mac)
• rsync -avzr ./build/html/ ../../arrow-site/ballista/

6. Commit changes in arrow-site and send a PR.