Lance Edgar
4e7c8d393c
i feel like there was a reason i hadn't done that to begin with, but now can't recall for sure. pylint certainly thinks it is duplicated so mostly cleaning this up per its suggestion...
70 lines
1.7 KiB
ReStructuredText
70 lines
1.7 KiB
ReStructuredText
|
|
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/
|
|
|
|
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
|
|
:target: https://github.com/pylint-dev/pylint
|
|
|
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
|
:target: https://github.com/psf/black
|
|
|
|
However as you can see..the API should be fairly well documented but
|
|
the narrative docs are pretty scant. That will eventually change.
|
|
|
|
For an online demo see https://demo.wuttaproject.org/
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Documentation:
|
|
|
|
narr/overview
|
|
glossary
|
|
narr/install
|
|
narr/cli/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Package API:
|
|
|
|
api/sideshow
|
|
api/sideshow.app
|
|
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.db.model.stores
|
|
api/sideshow.enum
|
|
api/sideshow.orders
|
|
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.util
|
|
api/sideshow.web.views
|
|
api/sideshow.web.views.batch
|
|
api/sideshow.web.views.batch.neworder
|
|
api/sideshow.web.views.common
|
|
api/sideshow.web.views.customers
|
|
api/sideshow.web.views.orders
|
|
api/sideshow.web.views.products
|
|
api/sideshow.web.views.stores
|