Sideshow
========

This is a web app which provides retailers a way to track case/special
orders.

Good documentation and 100% `test coverage`_ are priorities for this
project.

.. _test coverage: https://buildbot.rattailproject.org/coverage/sideshow/

However as you can see..the API should be fairly well documented but
the narrative docs are pretty scant.  That will eventually change.

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

   glossary
   narr/cli/index

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

   api/sideshow
   api/sideshow.batch
   api/sideshow.batch.neworder
   api/sideshow.cli
   api/sideshow.cli.base
   api/sideshow.cli.install
   api/sideshow.config
   api/sideshow.db
   api/sideshow.db.model
   api/sideshow.db.model.batch
   api/sideshow.db.model.batch.neworder
   api/sideshow.db.model.customers
   api/sideshow.db.model.orders
   api/sideshow.db.model.products
   api/sideshow.enum
   api/sideshow.web
   api/sideshow.web.app
   api/sideshow.web.forms
   api/sideshow.web.forms.schema
   api/sideshow.web.menus
   api/sideshow.web.static
   api/sideshow.web.views
   api/sideshow.web.views.batch
   api/sideshow.web.views.batch.neworder
   api/sideshow.web.views.customers
   api/sideshow.web.views.orders
   api/sideshow.web.views.products