commit | c0c477e8a8c5ff6837b17d38e986b1c9e254b02d | [log] [tgz] |
---|---|---|
author | Wes McKinney <wesm@users.noreply.github.com> | Fri Nov 30 15:48:27 2018 -0600 |
committer | GitHub <noreply@github.com> | Fri Nov 30 15:48:27 2018 -0600 |
tree | 9b332db2367d4d1c178c6d4d244a8b2f90f1c4e0 | |
parent | 69739d63e4e133d5e30146a589a32068960b33db [diff] |
[Website] Update website for 0.11.1 bugfix release (#3060) Change-Id: I5eddfb4c51ffd3ea5ad7f98a10c98addbcf3c883
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.