Documentation for the current published release can be found at https://arrow.apache.org/ballista and the source content is located here.
Developer documentation can be found here.
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.sh
The documentation is served through the arrow-site repository. To release a new version of the documentation, follow these steps:
- Download the release source tarball (we can only publish documentation from official releases)
- Run
./build.sh
insidedocs
folder to generate the docs website inside thebuild/html
folder. - Clone the arrow-site repo
- Checkout to the
asf-site
branch (NOTmaster
) - Copy build artifacts into
arrow-site
repo'sballista
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/
- Commit changes in
arrow-site
and send a PR.