.. pyiCub-doc documentation master file, created by
   sphinx-quickstart on Wed Jul  2 10:19:43 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Pyicub Documentation
====================

Welcome to the official documentation for `pyiCub <https://github.com/s4hri/pyicub>`_ — an open-source Python interface for interacting with the iCub humanoid robot.


Icub RST model
--------------

You can now explore the **pyiCub RST model** to play with and understand the joints:
:doc:`geometry/Icub`

Overview
--------

`pyiCub <https://github.com/s4hri/pyicub>`_ simplifies communication and control of the iCub robot through a modular and developer-friendly Python API. It includes tools for development, testing, and integration, making it suitable for researchers, developers, and roboticists.

Whether you're contributing to development or just getting started, this documentation will help you navigate the system and contribute effectively.

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Getting started:

   getting_started/installation

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Design:

   design/structure
   design/system_architecture
   design/coding_standards

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: api:

   api/api

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: development:

   development/how_to_develop
   development/docker
   development/continuous_integration
   development/testing_practices
   development/releases


.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: contribute:

   contributions/project_contribution
   contributions/doc_contribution
   contributions/testing
   contributions/pull_requests
   contributions/github
   contributions/github_issues

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: icub robot:

   geometry/Icub