commit | 80e12020605e85064bf6174ec82191fb088fc546 | [log] [tgz] |
---|---|---|
author | Krisztián Szűcs <szucs.krisztian@gmail.com> | Wed Oct 10 12:29:37 2018 +0900 |
committer | Kouhei Sutou <kou@clear-code.com> | Wed Oct 10 12:29:37 2018 +0900 |
tree | befd637af0d89fdab3e96ef5bcc29ef1851d94db | |
parent | 069ee94322a79f243adc16e32b838d43aef8088d [diff] |
ARROW-3465: [Documentation] Fix gen_apidocs' docker image It's intend to be only a quickfix for building the apidocs. @kou I'm still building it locally. Author: Krisztián Szűcs <szucs.krisztian@gmail.com> Author: Kouhei Sutou <kou@clear-code.com> Closes #2723 from kszucs/ARROW-3465 and squashes the following commits: 461ef646 <Kouhei Sutou> Add index page for C GLib API document 5d14f2fd <Kouhei Sutou> Fix a typo ce6f52fc <Krisztián Szűcs> fix cpp build af84de6b <Krisztián Szűcs> install python dependencies efb4deb0 <Krisztián Szűcs> remove parquet-cpp eb1fb3be <Krisztián Szűcs> fix paths 1f34ac8f <Krisztián Szűcs> quickfix for building apidocs
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
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.