DataFusion docs

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

make html

Release

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

1. Run make html inside docs folder to generate the docs website inside the build/html folder.
2. Clone the arrow-site repo
3. Checkout to the asf-site branch (NOT master)
4. Copy build artifacts into arrow-site repo's datafusion folder with a command such as

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

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