Documentation

MkDocs

The documentation, i.e., the cQASM language specification, is generated using MkDocs.

mkdocs.yml                  # The configuration file.
mkdocs-base.yml             # Base configuration file.
docs/
    javascripts/            # JS configuration files for extensions.
    language-specification  # The cQASM language specification
    index.md                # The documentation homepage.

We use Material for MkDocs, a documentation framework on top of MkDocs.

You can serve the documentation locally at http://localhost:8000 by running

mkdocs serve

The documentation is hosted through GitHub pages. To deploy the docs run

mkdocs gh-deploy

Using the Docker Container

The documentation can also be viewed via the provisioned Docker container. Run the docker container with the following command

docker compose up -d

The documentation can now be viewed at http://localhost:8106.