commit | c1b21ba66851b3c76297c014e880ce5e5f61d547 | [log] [tgz] |
---|---|---|
author | Wes McKinney <wesm+git@apache.org> | Tue Feb 12 15:28:04 2019 +0100 |
committer | Korn, Uwe <Uwe.Korn@blue-yonder.com> | Tue Feb 12 15:28:04 2019 +0100 |
tree | 2266604cfb0a73abe2c393f80847d22449fddf8a | |
parent | 8cb2834f8e1d3f7f9748d08b258683f9e2991137 [diff] |
ARROW-4481: [Website] Remove generated specification docs from site after docs migration We no longer need to render the format docs as part of the Jekyll site, as they were ported to the master Sphinx project. As a result of this, the instructions to build the website were broken Author: Wes McKinney <wesm+git@apache.org> Closes #3620 from wesm/ARROW-4481 and squashes the following commits: 013d13bf <Wes McKinney> Remove generated specification docs from site after docs migration
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.