commit | e29693b2ff2becfbc29a7b4c175e3a477de8582a | [log] [tgz] |
---|---|---|
author | Kouhei Sutou <kou@clear-code.com> | Tue Oct 09 04:57:13 2018 -0400 |
committer | Wes McKinney <wesm+git@apache.org> | Tue Oct 09 04:57:13 2018 -0400 |
tree | 6a1ecd7fe785eda3ee8589c033d96efc55e4a453 | |
parent | 4b4ff77384f22c39f63a768b4f1889db6ae83e38 [diff] |
ARROW-3463: [Website] Update for 0.11.0 Author: Kouhei Sutou <kou@clear-code.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2722 from kou/website-update-for-0.11.0 and squashes the following commits: 0f573953a <Wes McKinney> Note about Parquet patches 2ffe9897a <Kouhei Sutou> Support running site/scripts/sync_format_docs.sh multiple times 6bbc8d9a3 <Kouhei Sutou> Update for 0.11.0
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
After following the above instructions the base site/
directory, run:
JEKYLL_ENV=production 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
To update the documentation, run the script ./dev/gen_apidocs.sh
. This script will run the code documentation tools in a fixed environment.
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/
cd ../js npm run doc rsync -r doc/ ../site/asf-site/docs/js
Then add/commit/push from the site/asf-site git checkout.