This folder contains the source content of the User Guide and Contributor Guide. These are both published to https://datafusion.apache.org/ as part of the release process.

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

python3 -m venv venv pip install -r requirements.txt

If using uv the script can be run like so without needing to create a virtual environment:

uv run --with-requirements requirements.txt bash build.sh

Run the provided script to build the HTML pages.

# If using venv, ensure you have activated it ./build.sh

The HTML will be generated into a build directory. Open build/html/index.html in your preferred browser, e.g.

Preview the site on Linux by running this command.

# On macOS open build/html/index.html # On Linux with Firefox firefox build/html/index.html

To make changes to the docs, simply make a Pull Request with your proposed changes as normal. When the PR is merged the docs will be automatically updated.

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

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://datafusion.apache.org/, which serves content based on the configuration in .asf.yaml, which specifies the target as https://datafusion.apache.org/.