This is a zsh script for generating Dash docsets for RethinkDB. It
creates four docsets -- JavaScript, Python, Ruby, and Java. The docsets
will be created in a build
directory directly under the _dash
directory.
The script requires pandoc for processing, which can be installed
from most package managers including Homebrew. Its other dependencies,
sed
and sqlite, are included with OS X. Building on non-OS X
systems has not been tested.
- Check out the
rethinkdb/docs
repository. - Check out this repository.
- Edit the
docroot=
line inmakedash.sh
to point to the top level of thedocs
directory. (If you check them out as siblings in a parent directory, it should run as-is.) - Run
makedash.sh
.
The docsets will be created in a build/
directory. This directory is
blown away and rebuilt by the build script.
Currently, all ReQL terms are categorized as "commands" in Dash's taxonomy. This may be made more granular in a later revision.