Files
jq/docs
Léane GRASSER 175b8e3c51 docs: update quoting rules for PowerShell 7.3+ (#3649)
The manual recommended backslash-escaped double quotes inside the jq
program for all PowerShell versions, but since PowerShell 7.3 native
command arguments are passed with standard quoting by default, so the
backslashes reach jq literally.

Describe the quoting rules separately for Unix shells and PowerShell
7.3+, for older PowerShell and Windows PowerShell, and for cmd.exe, and
update the examples to match.
2026-10-20 22:28:24 +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.