.. preflibtools documentation master file, created by
   sphinx-quickstart on Wed May 18 18:58:52 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=============
PrefLib-Tools
=============

.. image:: https://img.shields.io/pypi/v/preflibtools.svg
        :target: https://pypi.python.org/pypi/preflibtools
        :alt: PyPI Status

.. image:: https://github.com/PrefLib/preflibtools/workflows/build/badge.svg?branch=main
        :target: https://github.com/PrefLib/preflibtools/actions?query=workflow%3Abuild
        :alt: Build Status

.. image:: https://codecov.io/gh/PrefLib/preflibtools/branch/main/graphs/badge.svg
        :target: https://codecov.io/gh/PrefLib/preflibtools/tree/main
        :alt: Code Coverage

Welcome to the document of the PrefLib-Tools, a set of Python tools developed to work with preference data from the
`PrefLib.org website <https://www.preflib.org/>`_.

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

   installation
   usage
   reference/index
   about


Index
=====

The :ref:`general index <genindex>` can be found here.