.. title:: Home

.. include:: ../../README.rst
    :end-line: 11

.. note::

    The docstrings contained in the package are very brief and incomplete in
    many cases. This documentation is the only complete source of information
    about the package.

    To download the documentation, see :ref:`source-install`. See
    :ref:`sphinx-build <make_mode>` in the Sphinx docs for information about
    building it.

In This Documentation
=====================

.. toctree::
    :caption: General
    :maxdepth: 1

    Installation <installation>
    Basic Usage <usage>
    Algorithm Overview <algorithms>
    Changelog <changelog>

.. toctree::
    :caption: API
    :maxdepth: 1

    Functions <api/functions>
    Classes <api/classes>
    Constants <api/constants>