commit | b6313c88a45ec66529542c1cf348dfdc5a476133 | [log] [tgz] |
---|---|---|
author | Wes McKinney <wes.mckinney@twosigma.com> | Wed Aug 16 23:13:49 2017 -0400 |
committer | Wes McKinney <wes.mckinney@twosigma.com> | Wed Aug 16 23:13:49 2017 -0400 |
tree | 244a555c348b5d3c81191d2a35e0f30af993b647 | |
parent | 14918cbd58ff72d7718a2e598e2babebe3cfebaa [diff] |
ARROW-1365: [Python] Remove outdated pyarrow.jemalloc_memory_pool example. Update API doc site build instructions Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #973 from wesm/site-doc-updates and squashes the following commits: 8884b4a4 [Wes McKinney] Remove outdated pyarrow.jemalloc_memory_pool example. Add --with-plasma to Python doc build
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:
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/
Then add/commit/push from the site/asf-site git checkout.