Files
jq/docs
Dmitri Vereshchagin 633ae6058a Disable colored output on a dumb terminal (#3552)
Enable colored output by default only when the TERM environment variable
is set to a value other than dumb, as git and grep do, so that users no
longer need to pass -M or set NO_COLOR on terminals that cannot display
escape sequences. Colored output is now disabled not only for TERM=dumb
but also when TERM is unset or empty. The -C option still enables colors
in all these cases. On Windows, colored output is still decided by
ANSICON and the console mode, and TERM is not checked.
2026-10-16 21:50:47 +09:00
..

Documentation

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

To build the documentation (including building the jq manpage), you'll need python3 and pipenv. You can install pipenv like so:

pip install pipenv

Though, you may need to say pip3 instead, depending on your system. Once you have pipenv installed, you can install the dependencies by running pipenv sync from the docs/ directory.

Also, you may need to run virtualenv -p /usr/bin/python3 venv/ and then source venv/bin/activate, and only then pipenv sync.

Once this is done, rerun ./configure --enable-docs in the jq root directory and then the Makefile will be able to generate the jq manpage. You can just run make jq.1 to build the manpage manually, and make tests/man.test to update the manual tests.

To build the website, run pipenv run python3 build_website.py in the docs/ directory. To serve them locally, you can run python3 -m http.server -d output.