.. currentmodule:: sardana

.. _sardana-python-package-reference:

========================
Python package reference
========================

Use this reference when you know which :mod:`sardana` package or module you
need. For a task-oriented guide to the supported extension and integration
APIs, start with the :doc:`Python API overview <../api_sardana>`.

.. toctree::
    :hidden:
    :maxdepth: 1

    Core modules <core>
    Pool <pool>
    MacroServer <macroserver>
    Spock <spock>
    Tango integration <tango>
    Taurus integration <taurus>

Choose a starting point
-----------------------

* :doc:`Core modules <core>` -- shared definitions, base classes, events,
  managers, metadata and values.
* :doc:`Pool internals <pool>` -- controllers, acquisition, motion and pool
  elements in :mod:`sardana.pool`.
* :doc:`MacroServer, macros and scans <macroserver>` -- macro execution,
  environments, recorders and scan infrastructure in
  :mod:`sardana.macroserver`.
* :doc:`Spock <spock>` -- the interactive command-line integration in
  :mod:`sardana.spock`.
* :doc:`Tango integration <tango>` -- Sardana's Tango devices and servers in
  :mod:`sardana.tango`.
* :doc:`Taurus integration <taurus>` -- client models and Qt integration in
  :mod:`sardana.taurus`.

Implementation source
---------------------

Documented classes and functions include ``[source]`` links that open their
Python implementation through Sphinx. The ``View page source`` action opens
the reStructuredText documentation source instead.

The complete implementation is also available in the
`Sardana source tree on GitLab`_.

Indexes
-------

* :ref:`Python module index <modindex>`
* :ref:`General index <genindex>`

The :mod:`sardana` package
--------------------------

.. automodule:: sardana

Packages
--------

* :doc:`Pool <pool>`
* :doc:`MacroServer <macroserver>`
* :doc:`Spock <spock>`
* :doc:`Tango integration <tango>`
* :doc:`Taurus integration <taurus>`

.. _Sardana source tree on GitLab: https://gitlab.com/sardana-org/sardana/-/tree/develop/src/sardana