commit | 5e94176ab790048b669be564f4e6f7717d1f2951 | [log] [tgz] |
---|---|---|
author | Kouhei Sutou <kou@clear-code.com> | Mon Jan 21 13:27:09 2019 +0100 |
committer | Krisztián Szűcs <szucs.krisztian@gmail.com> | Mon Jan 21 13:27:09 2019 +0100 |
tree | 1d11db1266cad236a93f6a8739c602233de9b5f9 | |
parent | 51263c6070df1630902017a5336bde2c18d9708e [diff] |
ARROW-4310: [Website] Update install document for 0.12.0 Author: Kouhei Sutou <kou@clear-code.com> Closes #3442 from kou/doc-update-install and squashes the following commits: 4cd4563c <Kouhei Sutou> Update install document for 0.12.0
If you are planning to publish the website, you must first clone the arrow-site git repository:
git clone --branch=asf-site https://github.com/apache/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.