This repository contains the source files for the documentation of the Quantum Instrumentation Controller Kit software, generated via Sphinx and available on ReadTheDocs.

To build the Sphinx documentation locally:

export READTHEDOCS=True
make html

If you want to build in nitpicky mode to generate warning for bad references, use make html SPHINXOPTS='-n'.

To check validity of external links, use make linkcheck.

The documentation for QICK is available at: https://qick-docs.readthedocs.io

Documentation generated from this project: http://romanvm.github.io/sphinx_tutorial/

License: Creative Commons Share Alike