tree: 4f41220fc138728c74fa5565ec212aa7c782dcb4 [path history] [tgz]
  1. source/
  2. .gitignore
  3. make.bat
  4. Makefile
  5. README.md
  6. requirements.txt
docs/README.md

DataFusion docs

Dependencies

It's recommended to install build dependencies and build the 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:

  • Run make html inside docs folder to generate the docs website inside the build/html folder.
  • Clone the arrow-site repo and checkout to the asf-site branch
  • Copy build artifacts into arrow-site repo's datafusion folder: 'cp' -rT ./build/html/ ../arrow-site/datafusion/
  • Commit changes in arrow-site and send a PR.