commit | 58efa3c39c16fbe3fc71da78d37238fb18d4d305 | [log] [tgz] |
---|---|---|
author | Andy Grove <andy.grove@rms.com> | Tue Jan 22 20:19:08 2019 -0700 |
committer | Andy Grove <andygrove73@gmail.com> | Tue Jan 22 20:19:08 2019 -0700 |
tree | 5b6139712d1f7e84df2474a0b6845f029c5fe489 | |
parent | 202ee6b78059a608faeb2326c20308c912b59ec7 [diff] |
ARROW-4315: [Website] Add Go and Rust to list of supported languages Author: Andy Grove <andy.grove@rms.com> Closes #3460 from agrove-rms/ARROW-4315 and squashes the following commits: d3d06f1 <Andy Grove> Add C# and R 0a15d08 <Andy Grove> Add Go and Rust to list of supported languages
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.