commit | 202ee6b78059a608faeb2326c20308c912b59ec7 | [log] [tgz] |
---|---|---|
author | Wes McKinney <wesm+git@apache.org> | Mon Jan 21 08:56:41 2019 -0600 |
committer | Wes McKinney <wesm+git@apache.org> | Mon Jan 21 08:56:41 2019 -0600 |
tree | f1a0ea39e284ff8c47bf3914412b69a602a52c22 | |
parent | f1a953152be68ad257d85c3bdd4f5487ba94eba2 [diff] |
[Website] Add link to top-level documentation to nav dropdown Change-Id: Ie885cbdf9309eaddb639aa9ecf4d2d85b8fb7de8
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.