Qtile Documentation
===================

Everything you need to know about Qtile.

Installing
----------

* **Getting started**:
  :doc:`Overview </manual/install/index>` |
  :doc:`From source </manual/install/source>`

* **Distro guides**:
  :doc:`Arch Linux </manual/install/arch>` |
  :doc:`Funtoo </manual/install/funtoo>` |
  :doc:`Gentoo </manual/install/gentoo>` |
  :doc:`Ubuntu </manual/install/ubuntu>` |
  :doc:`Debian </manual/install/debian>`

Configuration
-------------

* **The basics**:
  :doc:`Default Configuration </manual/config/default>` |
  :doc:`Overview </manual/config/index>` |
  :doc:`Starting Qtile </manual/config/starting>` |
  :doc:`Hooks </manual/config/hooks>` |
  :doc:`Running inside Gnome </manual/config/gnome>`

* **Config variables**:
  :doc:`groups </manual/config/groups>` |
  :doc:`keys </manual/config/keys>` |
  :doc:`layouts </manual/config/layouts>` |
  :doc:`mouse </manual/config/mouse>` |
  :doc:`screens </manual/config/screens>`

* **Examples**:
  `Default config <https://github.com/qtile/qtile/blob/master/libqtile/resources/default_config.py>`_ |
  `qtile-examples <https://github.com/qtile/qtile-examples>`_

Commands and scripting
----------------------

* **The basics**:
  :doc:`Overview </manual/commands/index>`

* **Diving in**:
  :doc:`Scripting </manual/commands/scripting>` |
  :doc:`qsh </manual/commands/qsh>`

Reference
---------

* :doc:`Built-in Hooks </manual/ref/hooks>`
* :doc:`Built-in Layouts </manual/ref/layouts>`
* :doc:`Built-in Widgets </manual/ref/widgets>`

Miscellaneous
-------------

* :doc:`Frequently Asked Questions </manual/faq>`
* :doc:`Hacking Qtile </manual/hacking>`
* :doc:`Release notes </releases/index>`
* :doc:`License </manual/license>`


.. toctree::
    :glob:
    :hidden:

    /manual/install/index
    /manual/install/*
    /manual/config/index
    /manual/config/*
    /manual/commands/index
    /manual/commands/*
    /manual/ref/index
    /manual/ref/*
    /manual/*
    /releases/index
    /releases/*