Welcome to lattice docs, the documentation files for the lattice and HQS cloud.lattice.

The Docs files get on the one hand built by the pipeline of this repo and will after that live in the gitlab pages. On the other hand another repo for QAD exists (scce-docs) which deployes the docs.

To create the static HTML-files to be able to view the Docs locally execute the following installations in the main folder of scce (in case you havn't installed scce)

pip install --no-deps .

Then navigate to the doc folder and execute the following commands:

make html
make html

This will create the html files for the docs in scce/doc/_build/html.

For building the HQS cloud.lattice view you have to use

make SPHINXOPTS="-Dmaster_doc=index_cloud" html
make SPHINXOPTS="-Dmaster_doc=index_cloud" html

You will need the following packages:

- lattice_validator
- spinx
- nbsphinx
- sphinx-rtd-theme
- recommonmark