commit | 069ee94322a79f243adc16e32b838d43aef8088d | [log] [tgz] |
---|---|---|
author | Kouhei Sutou <kou@clear-code.com> | Wed Oct 10 09:24:30 2018 +0900 |
committer | Kouhei Sutou <kou@clear-code.com> | Wed Oct 10 09:24:30 2018 +0900 |
tree | fcb2669341027e1f9a76543f4dca9840f0f3320d | |
parent | e29693b2ff2becfbc29a7b4c175e3a477de8582a [diff] |
ARROW-3480: [Website] Fix broken install document for Ubuntu Author: Kouhei Sutou <kou@clear-code.com> Closes #2737 from kou/website-fix-ubuntu-install and squashes the following commits: e4c647eb <Kouhei Sutou> Fix broken install document for Ubuntu
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.