Welcome to the Guitares documentation!
======================================

.. figure:: ./img/main/delftdashboard.png
   :width: 600px
   :align: center

Guitares is a Python package for building configurable Graphical User Interfaces (GUIs) using the PyQt5 framework. GUI configurations can be defined programmatically, but are typically provided by the developer in YAML configuration files.

A Guitares GUI consists of a main window (with optional drop-down menu) that contains one or more UI elements. Guitares currently supports the following UI elements (or widgets):

* Tab panels
* Frames
* Edit boxes
* Text
* Pop-up menus
* List boxes
* Check boxes
* Radio buttons
* Sliders
* Push buttons
* Web views
* MapBox maps

Please see the Elements section for more information about each UI element.

Check out the :doc:`getting_started` section for instructions on how to get started!

.. note::

   This project is under active development.

Contents
--------

.. toctree::

   getting_started
   simple_example
   elements
   menu
   variables
   callbacks
   positioning
   guiobject
   configuration
   dependencies
   tabpanels
   mapbox
   stylesheets
   examples