itchyny
fa6a2ff688
We no longer use the `--root` option of `build_website.py` since we have moved to jqlang.org (from jqlang.github.io/jq where the root was `/jq`). We don't need the option on local development either since `http.server` has the `-d` option to specify the directory to serve from.
1.0 KiB
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.