commit | 1722fdbb7033dd48a0ca80aea2d676d3cd347981 | [log] [tgz] |
---|---|---|
author | lmeyerov <lmeyerov@gmail.com> | Mon Feb 26 17:05:25 2018 -0500 |
committer | Wes McKinney <wes.mckinney@twosigma.com> | Mon Feb 26 17:05:25 2018 -0500 |
tree | ac6f363bfa7696e54cfbdcddfc05a6d986dff9f6 | |
parent | 9ca26ae5ac5527debda5130bcd1b075f351f6552 [diff] |
ARROW-2206: [JS] Document Perspective project See https://issues.apache.org/jira/browse/ARROW-2206 + https://github.com/deepankarsharma Author: lmeyerov <lmeyerov@gmail.com> Closes #1652 from lmeyerov/patch-2 and squashes the following commits: 904e1725 <lmeyerov> fix(reduce perspective description) 91291a09 <lmeyerov> fix(Perspective description) b8ef13ec <lmeyerov> fix(missing colon) 80a46306 <lmeyerov> Document Perspective project (main site) cc938c1a <lmeyerov> ARROW-2206 - Document Perspective project
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
cd ../java mvn install mvn site rsync -r target/site/apidocs/ ../site/asf-site/docs/java/
cd ../cpp/apidoc doxygen Doxyfile rsync -r html/ ../../site/asf-site/docs/cpp
First, build PyArrow with all optional extensions (Apache Parquet).
cd ../python python setup.py build_ext --inplace --with-parquet --with-plasma python setup.py build_sphinx -s doc/source rsync -r doc/_build/html/ ../site/asf-site/docs/python/
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.