DataFusion Documentation

This folder contains the source content of the Python API. This is published to https://datafusion.apache.org/python by a GitHub action when changes are merged to the main branch.

Dependencies

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

To prepare building the documentation run the following on the root level of the project:

1. Set up virtual environment if it was not already created

   python3 -m venv venv
   

2. Activate virtual environment

   source venv/bin/activate
   

3. Install Datafusion's Python dependencies

   pip install -r requirements-310.txt
   

4. Install documentation dependencies

   pip install -r docs/requirements.txt
   

Build & Preview

Run the provided script to build the HTML pages.

cd docs
./build.sh

The HTML will be generated into a build directory.

Preview the site on Linux by running this command.

firefox build/html/index.html

Release Process

This documentation is hosted at https://datafusion.apache.org/python

When the PR is merged to the main branch of the DataFusion repository, a github workflow which:

1. Builds the html content
2. Pushes the html content to the asf-site branch in this repository.

The Apache Software Foundation provides https://arrow.apache.org/, which serves content based on the configuration in .asf.yaml, which specifies the target as https://datafusion.apache.org/python.