tree: 1dd07989d040ed863ad5c57309cb32b9486c41ff [path history] [tgz]
  1. .gitignore
  2. Pipfile
  3. Pipfile.lock
  4. README.md
  5. build_manpage.py
  6. build_mantests.py
  7. build_website.py
  8. content/
  9. public/
  10. site.yml
  11. templates/
docs/README.md

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 install from the docs directory.

Once this is done, rerun ./configure in the jq root directory and then the Makefile will be able to generate the jq manpage.

To build the website, run pipenv run ./build_website.py from inside the docs directory.