commit | bb1367ccfbf77aef65d177a68cf7d231a043263b | [log] [tgz] |
---|---|---|
author | Korn, Uwe <Uwe.Korn@blue-yonder.com> | Mon May 21 14:33:10 2018 -0400 |
committer | Wes McKinney <wesm+git@apache.org> | Mon May 21 14:33:10 2018 -0400 |
tree | 9e105756a1a7068e6550deb0c467ffc94a22cadc | |
parent | 4d600c2e3b5d09948bb36e63d3fe4067f2c3f283 [diff] |
ARROW-2613: [Docs] Update the gen_apidocs docker script Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Closes #2068 from xhochy/ARROW-2613 and squashes the following commits: ec955c4a <Korn, Uwe> ARROW-2613: Update the gen_apidocs docker script
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.