This folder contains the source content of the python api. These are both published to https://arrow.apache.org/datafusion/ as part of the release process.
It's recommended to install build dependencies and build the documentation inside a Python virtualenv.
- Python
pip install -r requirements.txt
Run the provided script to build the HTML pages.
./build.shThe HTML will be generated into a build directory.
Preview the site on Linux by running this command.
firefox build/html/index.htmlThe documentation is served through the arrow-site repo. To release a new version of the docs, follow these steps:
- Run
./build.shinsidedocsfolder to generate the docs website inside thebuild/htmlfolder. - Clone the arrow-site repo
- Checkout to the
asf-sitebranch (NOTmaster) - Copy build artifacts into
arrow-siterepo'sdatafusionfolder with a command such as
cp -rT ./build/html/ ../../arrow-site/datafusion/(doesn't work on mac)rsync -avzr ./build/html/ ../../arrow-site/datafusion/
- Commit changes in
arrow-siteand send a PR.