Files
jq/docs
David Tolnay 81f328f1aa Copy over changes made to gh-pages directly
This includes the following commits from the gh-pages branch:

 - 63e80b8
 - d24a397
 - 9796cd6
 - ee21707
 - ccb0f1d
 - 200e6b3
 - 64134c0
 - 57152d2
 - 8ffbfa3
2015-07-23 21:51:30 -07:00
..
2013-05-19 11:48:18 +01:00
2012-09-18 17:51:53 +01:00
2013-05-06 01:15:33 +01:00
2015-04-22 11:01:39 -05:00
2014-06-16 13:25:50 -05:00

Documentation

The jq website, manpages and some of the tests are generated from this directory. The directory holds a Bonsai website, and the manual is a YAML file in content/3.manual.

To build the documentation (including building the jq manpage), you'll need a working Ruby setup. The easiest way to get one is to install RVM and Ruby 1.9.3 like so:

\curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3

After that finishes installing, you'll need to make sure RVM is on your path by doing source $HOME/.rvm/scripts/rvm, or just opening a new shell. See http://rvm.io for more info on RVM.

Once RVM is installed, you can install all the dependencies for jq's documentation build by running this from the docs directory:

bundle install

When bundle manages to install the dependencies, rerun ./configure in the jq root directory and then the Makefile will be able to generate the jq manpage.