The generated documentation is available at the following URL.

https://sitepark.github.io/atoolo-docs/

The documentation is generated with the static site generator Zensical.

Install Zensical

Zensical is installed into a virtual environment with the version pinned in requirements.txt.

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Update requirements

pip install --upgrade -r requirements.txt

Update GraphQL API Reference

The API reference docs/develop/graphql/reference.md is generated automatically using a GraphQL schema. The script tools/gen-reference.sh is available for this purpose. This expects a URL to a GraphQL endpoint via which the schema is to be read.

./tools/gen-reference.sh [--http] [www.domain.de]

In the standard case, the URL http://atoolo-e2e-test:9090/api/graphql/ is used. This provides the schema without customer-specific extensions.

See also atoolo-e2e-test

This creates the Markdown file docs/develop/graphql/reference.md from the schema.

Building the site

zensical build --clean

This will create a new directory named public where the generated documentation will be stored.

Write documentation

Zensical comes with a built-in dev-server that lets you preview your documentation as you work on it.

zensical serve