Skip to content

Files

Latest commit

aebc412 · Sep 19, 2017

History

History
This branch is 3 commits ahead of, 16147 commits behind apache/arrow:main.

site

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jun 16, 2017
Apr 24, 2017
Aug 29, 2017
May 8, 2017
Sep 19, 2017
Sep 19, 2017
Apr 24, 2017
May 31, 2017
Jun 16, 2017
Apr 24, 2017
Apr 24, 2017
Apr 28, 2017
Aug 17, 2017
May 31, 2017
May 12, 2017
Aug 16, 2017
Sep 19, 2017
Sep 19, 2017

Apache Arrow Website

Development instructions

If you are planning to publish the website, you must first clone the arrow-site git repository:

git clone --branch=asf-site https://git-wip-us.apache.org/repos/asf/arrow-site.git asf-site

Now, with Ruby >= 2.1 installed, run:

gem install jekyll bundler
bundle install

# This imports the format Markdown documents so they will be rendered
scripts/sync_format_docs.sh

bundle exec jekyll serve

Publishing

After following the above instructions the base site/ directory, run:

bundle exec jekyll build
rsync -r build/ asf-site/
cd asf-site
git status

Now git add any new files, then commit everything, and push:

git push

Updating Code Documentation

Java

cd ../java
mvn install
mvn site
rsync -r target/site/apidocs/ ../site/asf-site/docs/java/

C++

cd ../cpp/apidoc
doxygen Doxyfile
rsync -r html/ ../../site/asf-site/docs/cpp

Python

First, build PyArrow with all optional extensions (Apache Parquet).

cd ../python
python setup.py build_ext --inplace --with-parquet --with-plasma
python setup.py build_sphinx -s doc/source
rsync -r doc/_build/html/ ../site/asf-site/docs/python/

C (GLib)

First, build Apache Arrow C++ and Apache Arrow GLib.

mkdir -p ../cpp/build
cd ../cpp/build
cmake .. -DCMAKE_BUILD_TYPE=debug
make
cd ../../c_glib
./autogen.sh
./configure \
  --with-arrow-cpp-build-dir=$PWD/../cpp/build \
  --with-arrow-cpp-build-type=debug \
  --enable-gtk-doc
LD_LIBRARY_PATH=$PWD/../cpp/build/debug make GTK_DOC_V_XREF=": "
rsync -r doc/reference/html/ ../site/asf-site/docs/c_glib/

Then add/commit/push from the site/asf-site git checkout.