..

Welcome to fuzzytree's documentation!
=====================================

This is a reference to the `fuzzytree` module.
For implementation details, you can visit its `repository`_ on GitHub.

.. _repository: https://github.com/balins/fuzzytree

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

   quick_start

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Documentation

   user_guide
   api

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Examples

   auto_examples/index

`Getting started <quick_start.html>`_
-------------------------------------

Basic information regarding usage of the `fuzzytree` module.

`User Guide <user_guide.html>`_
-------------------------------

A gentle introduction to the usage of `fuzzytree`'s API.

`API Documentation <api.html>`_
-------------------------------

The `fuzzytree`'s public API documentation.

`Examples <auto_examples/index.html>`_
--------------------------------------

A set of examples. It complements the `User Guide <user_guide.html>`_.