commit | 6032e2b17e3df4f5c0a4eb56fb5126738de55e9c | [log] [tgz] |
---|---|---|
author | Korn, Uwe <Uwe.Korn@blue-yonder.com> | Sat Jul 21 18:04:43 2018 +0200 |
committer | Korn, Uwe <Uwe.Korn@blue-yonder.com> | Sat Jul 21 18:04:43 2018 +0200 |
tree | 0fb039938731ec92a27246b4a46ddea4140ccf10 | |
parent | bb1367ccfbf77aef65d177a68cf7d231a043263b [diff] |
ARROW-2855: [C++] Blog post that outlines the benefits of using jemalloc I will update the date once this has passed review. Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Closes #2271 from xhochy/ARROW-2855 and squashes the following commits: dbb7bc4a <Korn, Uwe> Prepare post for publish 7410ada2 <Korn, Uwe> Review comments and typos 298f4eb8 <Korn, Uwe> ARROW-2855: Blog post that outlines the benefits of using jemalloc
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.