pregenerated html docs about jq HOT 6 CLOSED

Good idea, will do for next release.

from jq.

Release 1.3 has pregenerated docs.

from jq.

I see the tarball (http://stedolan.github.io/jq/download/source/jq-1.3.tar.gz) has jq.1 pregenerated man page - it would be great to have pregenerated html docs too.

Also, would you consider including both these in the commits? I know it's inefficient, repeating the yml expanded to html, but it would be convenient to not have to install ruby etc to see html docs for the development version.

from jq.

Yeah, the tarballs should probably ship with docs/output prebuilt.

Including the pregenerated stuff in the commits is unlikely to happen. Efficiency isn't the concern. I do actually read the commit logs, especially when debugging, and I don't want every change to be eclipsed with a few hundred lines of manpage and HTML. Also, when merging branches and pull requests, there would almost invariably be conflicts between two branches' versions of generated docs.

Do try RVM if you haven't already (see docs/README.md). One command will get a Ruby install up and running.

from jq.

Diffs are a really good point. (The merging point is even better.) it might be possible to have a separate branch for them (automatically handled), but a hassle.

I've tried RVM. It's a nightmare, the complex fragmented docs, the different versions of itself. Ruby also is a nightmare, with breaking changes in point releases. It used to be an easy language to get started with, but now is more serving established users/experts/commercial users. Java had this baked in from the start, whereas ruby is a fun, radical language trying to become a suit. </rant>

I'm also running into disk-space limits on my tiny machine, so that's probably the real reason :-). I might try your RVM oneliner https://github.com/stedolan/jq/blob/master/docs/README.md

from jq.

I'm also running into disk-space limits on my tiny machine, so that's probably the real reason

RVM does like to download all of the internet twice. I wouldn't know about its terrible docs, I don't think I've ever read them beyond "copy-paste this line into your shell and suddenly a Ruby appears".

The breaking changes in point releases of Ruby are indeed horrible. The one-liner in README.md downloads the version of Ruby I'm using; I haven't tested others.

from jq.