diff --git a/docs/devices/devices_basics.rst b/docs/devices/devices_basics.rst index 12e6df8..cb457ce 100644 --- a/docs/devices/devices_basics.rst +++ b/docs/devices/devices_basics.rst @@ -3,7 +3,10 @@ Basics of device communication ====================================== -The devices are represented as Python objects, in most cases, one per device. +The devices are represented as Python objects, in most cases, one per device. All the device control functions is contained there. Occasionally, there are auxiliary function present for listing available devices, dealing with data generated by the device, or adjusting global parameters. + +.. note:: + Some specific devices functionality might not be completely covered in the current release. If this is the case for your device, you can let the developers know by raising an `issue on GitHub `__, or sending an e-mail to pylablib@gmail.com. .. _devices_connection: diff --git a/docs/index.rst b/docs/index.rst index 4307c67..6114edf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,9 @@ Additional utilities are added to simplify data acquisition, storage, and proces The library only works on Python 3, and has been most extensively tested on Windows 10 with 64-bit Python. Linux is, in principle, supported, but devices which require manufacturer-provided DLLs (mostly cameras) might, potentially, have problems. +.. note:: + This is documentation for the newer **1.x** version of the library. The older **0.x** documentation can be found at https://pylablib-v0.readthedocs.io/en/latest/ . + .. toctree:: :maxdepth: 2 :includehidden: diff --git a/docs/install.rst b/docs/install.rst index 7be2d52..366dfb3 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -3,6 +3,7 @@ Installation ========================= +.. _install-standard: Standard install ------------------------- @@ -13,7 +14,7 @@ You can install the library from PyPi: pip install pylablib -If you already, have it install, you need to upgrade it: +If you already have it installed, you must upgrade it to get the newest version: .. code-block:: none @@ -25,6 +26,8 @@ This will install the full set of dependencies: basic dependencies and computing pip install -U pylablib[devio-full] +.. _install-minimal: + Minimal install ------------------------- @@ -50,6 +53,8 @@ The options can be combined. For example, installs the dependencies as the usual pylablib distribution, but with PySide2 Qt5 backend instead of PyQt5. +.. _install-usage: + Usage ------------------------- @@ -68,6 +73,8 @@ More advanced features (e.g., :ref:`device communication `) shou frame = cam.snap() # grab a single frame cam.close() # close the connection +.. _install-requirements: + Dependencies and requirements ------------------------------ @@ -119,6 +126,8 @@ The most recent and extensive, but less tested and documented, version of this l in the library folder. Keep in mind that any changes that you make to the library code might conflict with the new version that you pull from GitHub, so you should not modify anything in this folder if possible. +.. _install-feedback: + Support and feedback -------------------------