Merge pull request #850 from qutech/doc/polish_2024_06

Fix documentation warnings

README.md

@@ -44,7 +44,7 @@ which will clone the github repository to `./src/qupulse` and do an editable/dev
 qupulse requires at least Python 3.8 and is tested on 3.8, 3.9 and 3.10. It relies on some external Python packages as dependencies. 
 We intentionally did not restrict versions of dependencies in the install scripts to not unnecessarily prevent usage of newer releases of dependencies that might be compatible. However, if qupulse does encounter problems with a particular dependency version please file an issue. 
 
-The backend for TaborAWGs requires packages that can be found [here](https://git.rwth-aachen.de/qutech/python-TaborDriver). As a shortcut you can install it from the python interpreter via `qupulse.hardware.awgs.install_requirements('tabor')`.
+The backend for TaborAWGs requires packages that can be found [here](https://git.rwth-aachen.de/qutech/python-TaborDriver).
 
 The data acquisition backend for AlazarTech cards needs a package that unfortunately is not open source (yet). If you need it or have questions contact <[email protected]>.
 

doc/source/concepts/pulsetemplates.rst

@@ -8,7 +8,7 @@ qupulse represents pulses as abstract pulse templates. A pulse template can be u
 There are multiple types of different pulse template classes, briefly explained in the following.
 
 :class:`.TablePulseTemplate`, :class:`.PointPulseTemplate` and :class:`.FunctionPulseTemplate` are used to define the atomic building blocks of pulses in the following ways: :class:`.TablePulseTemplate` and :class:`.PointPulseTemplate` allow the user to specify pairs of time and voltage values and choose an interpolation strategy between neighbouring points. Both templates support multiple channels but :class:`.TablePulseTemplate` allows for different time values for different channels meaning that the channels can change their voltages at different times. :class:`.PointPulseTemplate` restricts this to switches at the same time by interpreting the voltage as a vector and provides a more convenient interface for this case.
-:class:`.FunctionPulseTemplate` accepts any mathematical function that maps time to voltage values. Internally it uses :class:`.Expression` for function evaluation.
+:class:`.FunctionPulseTemplate` accepts any mathematical function that maps time to voltage values. Internally it uses :class:`qupulse.expressions.Expression` for function evaluation.
 
 All other pulse template classes are then used to construct arbitrarily complex pulse templates by combining existing ones into new structures [#tree]_:
 :class:`.SequencePulseTemplate` enables the user to specify a sequence of existing pulse templates (subtemplates) and modify parameter values using a mapping function.

doc/source/examples/examples.rst

@@ -45,6 +45,7 @@ All examples are provided as static text in this documentation and, additionally
     :name: hardware_examples
 
     02CreatePrograms
+    04ZurichInstrumentsSetup
 
 The ``/doc/source/examples`` directory also contains some outdated examples for features and functionality that has been changed. These examples start with an underscore i.e. ``_*.ipynb`` and are currently left only for reference purposes.
 If you are just learning how to get around in qupulse please ignore them.

doc/source/learners_guide.rst

@@ -97,4 +97,4 @@ Read :ref:`program` and :ref:`hardware`.
 Setup an experiment
 ^^^^^^^^^^^^^^^^^^^
 
-This section is under construction. There is currently an outdated example :ref:`/examples/_HardwareSetup.ipynb`
+This process is not fully documented yet. qupulse gives you tools for very flexible setup configurations. However, there is an example setup with Zurich Instruments devices in :ref:`/examples/04ZurichInstrumentsSetup.ipynb`.

pyproject.toml

@@ -82,6 +82,7 @@ include = [
 
 [tool.hatch.envs.docs]
 dependencies = [
+  "qupulse[default,zurich-instruments]",
   "sphinx",
   "nbsphinx",
   "sphinx-rtd-theme"
@@ -106,6 +107,9 @@ html = """
   version = result.stdout.strip(); \
   subprocess.run(['sphinx-build', '-b', 'html', 'doc/source', 'doc/build/html', '-D', 'version=%s' % version, '-D', 'release=%s' % version])"
 """
+clean= """
+python -c "import shutil; shutil.rmtree('doc/build')"
+"""
 
 [tool.hatch.envs.changelog]
 detached = true