This directory contains the Sphinx source for the Apache DataFusion Java documentation site.
Building the docs requires Python 3.9 or newer and a working ./mvnw at the repo root (the build runs ./mvnw javadoc:javadoc to generate the API reference, which also needs JDK 17 and one-time network access to fetch upstream .proto files). A virtual environment under docs/venv/ is the recommended workflow.
cd docs python3 -m venv venv source venv/bin/activate pip install -r requirements.txt ./build.sh
The generated site is written to docs/build/html/. Open docs/build/html/index.html in a browser to preview.
Subsequent builds need only:
cd docs source venv/bin/activate ./build.sh
./build.sh runs sphinx-build with -W so warnings fail the build.