commit | 5789e5358c5250d08051b97069f0b99797987769 | [log] [tgz] |
---|---|---|
author | Amir Szekely <kichik@gmail.com> | Fri Sep 28 10:25:48 2018 +0200 |
committer | Krisztián Szűcs <szucs.krisztian@gmail.com> | Fri Sep 28 10:25:48 2018 +0200 |
tree | ce6fc31468e85961233f6034b411c5335549f76b | |
parent | a8c27c4199db37ad883d8ceb9a8b413b1fa9f558 [diff] |
ARROW-3350: [Website] Fix powered by links Author: Amir Szekely <kichik@gmail.com> Closes #2647 from kichik/patch-1 and squashes the following commits: a122e5cf <Amir Szekely> Fix link & add PR link
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.