.. raw:: html

  <picture style="padding-bottom: 1em;">
    <source srcset="https://raw.githubusercontent.com/eclipse-ankaios/ankaios/main/logo/Ankaios__logo_for_light_bgrd_clipped.png">
    <img alt="Shows Ankaios logo" src="https://raw.githubusercontent.com/eclipse-ankaios/ankaios/main/logo/Ankaios__logo_for_light_bgrd_clipped.png" style="max-width: 100%; height: auto;">
  </picture>

.. mdinclude:: ../build/README.md

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting_started
   ankaios
   complete_state
   workload
   workload_state
   manifest
   request
   response
   control_interface
   utils
   exceptions

.. toctree::
   :maxdepth: 2
   :caption: Links:

   Ankaios Github <https://github.com/eclipse-ankaios/ankaios>
   Ankaios Python SDK Github <https://github.com/eclipse-ankaios/ank-sdk-python>

.. toctree::
   :maxdepth: 2
   :caption: Other:

   contributing
   code_of_conduct
   License <https://github.com/eclipse-ankaios/ank-sdk-python/blob/main/LICENSE>
   security

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`