.. kingston documentation master file, created by
   sphinx-quickstart on Wed Oct 14 20:03:48 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Funcy Kingston
==============

Funcy Kingston, or "Kingston" for short is a Python library with many
extras that I myself find useful. It depends on the excellent library
funcy. Funcy is a library to make Python programming more functional.

The best way to get started quickly is to read the :ref:`README <readme>`, below:

*Release:* v\ |release|. (:ref:`Install instructions <install>`)
*Development:* v\ |development|.

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

   install
   readme
   changelog

Examples
-------------

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

   examples/ormsnackis


API Reference
-------------

To read about the nitty-gritty inside Kingston, you can explore the
API documentation:

.. toctree::
   :maxdepth: 2

   api

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

* :ref:`readme`
* :ref:`search`
* :ref:`install`