This folder contains texts, configuration and scripts which are used to compile the documentation using sphinx. It also contains usage examples for qupulse.
You may either build the documentation yourself or read it on readthedocs.
In the subdirectory examples you can find various Jupyter notebook files providing some step-by-step examples of how qupulse can be used. These can be explored in an interactive fashion by running the Jupyter notebook application inside the folder. However, a static version will also be included in the documentation created with sphinx.
To build the documentation, you will need sphinx and nbsphinx which, in turn, requires pandoc which must be installed separately.
You can use hatch to build the documentation locally via hatch run docs:build <format> or a bit more concise hatch run docs:html. The output will then be found in /doc/build/<target>.