.. card_deck documentation master file, created by
   sphinx-quickstart on Sun Jun 20 19:49:24 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to card_deck's documentation!
=====================================

An object model of a pack of cards, written in Python, to streamline writing programs to model/play games involving cards

Installation
------------

The library package has been published on PyPi, so can be found here: https://pypi.org/project/card-deck/, and can be installed as follows:

.. code-block:: python

    pip install card-deck

Requirements
------------

There are no additional required libraries


Contents
--------

.. toctree::
   :maxdepth: 2

   autodoc
   usage
   project


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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`