commit | 8f760f2a4a660755cf703e2777d1cdb25fa21482 | [log] [tgz] |
---|---|---|
author | Hatem Helal <hatem.helal@gmail.com> | Tue Apr 16 14:24:33 2019 +0900 |
committer | Kouhei Sutou <kou@clear-code.com> | Tue Apr 16 14:24:33 2019 +0900 |
tree | b9b1abfae0f54114d02736158754734fbde13596 | |
parent | a2786c4adc607f7b2cfbf4b7630e8e520182b025 [diff] |
ARROW-5157: [Website] Add MATLAB to powered by Apache Arrow website @kevingurney, @rdmello, @DaveBergstein, @nickhaddady, and @jeremy-hughes let me know what you think of the wording of this. Thanks! Author: Hatem Helal <hatem.helal@gmail.com> Author: Hatem Helal <hhelal@mathworks.com> Closes #4137 from hatemhelal/arrow-5157 and squashes the following commits: 4afc859e <Hatem Helal> proper case 53a39d86 <Hatem Helal> Swap engineers and scientists 6aa29dc8 <Hatem Helal> Added more info about MATLAB 96b00b24 <Hatem Helal> Add MATLAB to powered by Apache Arrow website
Site content is maintained in the main Arrow repository, mostly in markdown format. Jekyll is used to generate HTML files that can then be committed to the arrow-site repository.
With Ruby >= 2.1 installed, run the following commands to install Jekyll.
gem install jekyll bundler
bundle install
If you are planning to publish the website, you must clone the arrow-site git repository. Run this command from the site
directory so that asf-site
is a subdirectory of site
.
git clone --branch=asf-site https://github.com/apache/arrow-site.git asf-site
From the site
directory, run the following to generate HTML files and run the web site locally.
bundle exec jekyll serve
After following the above instructions, run the following commands from the site
directory:
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.