tailbone/docs/index.rst
Lance Edgar 99ed897bf4 Add getting started doc for dev environment
also change docs theme
2018-01-11 12:15:37 -06:00

56 lines
931 B
ReStructuredText

Tailbone
========
Welcome to Tailbone, part of the Rattail project.
..
While the core Rattail package provides the data schema / ORM / application
layer, the Tailbone package provides the web application layer.
The documentation you are currently reading is for the Tailbone web application
package. Some additional information is available on the `website`_. Clearly
not everything is documented yet. Below you can see what has received some
attention thus far.
.. _website: https://rattailproject.org/
Getting Started:
.. toctree::
:maxdepth: 1
devenv
Narrative Documentation:
.. toctree::
narr/batches
Package API:
.. toctree::
:maxdepth: 1
api/grids
api/subscribers
api/views/batch
api/views/master
api/views/vendors.catalogs
Documentation To-Do
===================
.. todolist::
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`