tailbone/docs/index.rst


Tailbone
========

Welcome to Tailbone, part of the Rattail project.  While the core Rattail
package provides the data layer, the Tailbone package provides the (default,
back-end) web application layer.

Some additional information is available on the `website`_.  Certainly not
everything is documented yet, but here you can see what has received some
attention thus far.

.. _website: https://rattailproject.org/

Quick Start for Custom Apps:

.. toctree::
   :maxdepth: 1

   structure
   devenv
   newproject
   schemachange

Concept Guide:

.. toctree::

   concepts/config
   concepts/console
   concepts/schema
   concepts/batches

Narrative Documentation:

.. toctree::

   narr/batches

Package API:

.. toctree::
   :maxdepth: 1

   api/api/batch/core
   api/api/batch/ordering
   api/diffs
   api/forms
   api/grids
   api/grids.core
   api/progress
   api/subscribers
   api/views/batch
   api/views/batch.vendorcatalog
   api/views/core
   api/views/master
   api/views/members
   api/views/purchasing.batch
   api/views/purchasing.ordering


Documentation To-Do
===================

.. todolist::


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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Initial docs (as generated by sphinx-quickstart). 2014-02-16 01:18:30 -06:00
Docs tweak; testing buildbot. 2014-02-16 01:28:50 -06:00			`Tailbone`
			`========`
Initial docs (as generated by sphinx-quickstart). 2014-02-16 01:18:30 -06:00
Add docs for app structure, and creating new project 2018-01-15 21:37:10 -06:00			`Welcome to Tailbone, part of the Rattail project. While the core Rattail`
			`package provides the data layer, the Tailbone package provides the (default,`
			`back-end) web application layer.`
Initial docs (as generated by sphinx-quickstart). 2014-02-16 01:18:30 -06:00
Add docs for app structure, and creating new project 2018-01-15 21:37:10 -06:00			Some additional information is available on the `website`_. Certainly not
			`everything is documented yet, but here you can see what has received some`
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00			`attention thus far.`
Docs tweak; testing buildbot. 2014-02-16 01:28:50 -06:00
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00			`.. _website: https://rattailproject.org/`
Add event hook for attaching Rattail `config` to new requests. 2014-02-21 12:10:10 -06:00
Add basic schema docs 2018-01-15 23:19:29 -06:00			`Quick Start for Custom Apps:`
Add getting started doc for dev environment also change docs theme 2018-01-11 12:15:19 -06:00
			`.. toctree::`
			`:maxdepth: 1`

Add docs for app structure, and creating new project 2018-01-15 21:37:10 -06:00			`structure`
Add getting started doc for dev environment also change docs theme 2018-01-11 12:15:19 -06:00			`devenv`
Add docs for app structure, and creating new project 2018-01-15 21:37:10 -06:00			`newproject`
Add basic schema docs 2018-01-15 23:19:29 -06:00			`schemachange`

			`Concept Guide:`

			`.. toctree::`

Add placeholder doc for Configuration 2018-01-16 11:32:36 -06:00			`concepts/config`
Fix doc reference 2018-01-22 17:27:58 -06:00			`concepts/console`
Add basic schema docs 2018-01-15 23:19:29 -06:00			`concepts/schema`
Add concept doc for data batches 2018-01-16 00:22:46 -06:00			`concepts/batches`
Add getting started doc for dev environment also change docs theme 2018-01-11 12:15:19 -06:00
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00			`Narrative Documentation:`
Docs tweak; testing buildbot. 2014-02-16 01:28:50 -06:00
Docs tweak (test buildbot). 2014-02-16 02:04:17 -06:00			`.. toctree::`
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00
			`narr/batches`

			`Package API:`

			`.. toctree::`
			`:maxdepth: 1`
Initial docs (as generated by sphinx-quickstart). 2014-02-16 01:18:30 -06:00
Overhaul the /ordering batch API somewhat; update docs mostly a savepoint; the /ordering API still needs some work for sure 2020-02-23 21:07:50 -06:00			`api/api/batch/core`
			`api/api/batch/ordering`
Provide a way to show enum display text for some version diff fields master view must explicitly declare which enums for which fields 2023-11-30 18:23:47 -06:00			`api/diffs`
Add basic forms API doc 2018-05-22 20:29:07 -05:00			`api/forms`
Final grid refactor; we now have just 'grids' :) this also removes some old UI stuff for the first attempt at continuum versioning..among other cruft 2017-07-14 20:30:00 -05:00			`api/grids`
Make sure `Grid` class is included in package API docs 2022-11-19 21:45:23 -06:00			`api/grids.core`
Add core `View.make_progress()` method so callers no longer need to import `SessionProgress` and create directly 2019-09-25 00:10:17 -05:00			`api/progress`
Add event hook for attaching Rattail `config` to new requests. 2014-02-21 12:10:10 -06:00			`api/subscribers`
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00			`api/views/batch`
Fix docs, per recent view switcharoo 2019-10-09 14:21:48 -05:00			`api/views/batch.vendorcatalog`
Add core `View.make_progress()` method so callers no longer need to import `SessionProgress` and create directly 2019-09-25 00:10:17 -05:00			`api/views/core`
Add support for "new-style grids" and "model master views". Finally, an API that makes some sense... We don't yet have feature parity with the old-style grids and CRUD views, but this is already a significant improvement to the design. Still needs a lot of docs though... 2015-07-29 11:09:38 -05:00			`api/views/master`
Provide a way to show enum display text for some version diff fields master view must explicitly declare which enums for which fields 2023-11-30 18:23:47 -06:00			`api/views/members`
Tweak `save_edit_row_form()` of purchase batch view, to leverage handler specifically this is to make use of handler's `update_row_quantity()` method, when editing a row for ordering batches 2020-02-24 12:27:26 -06:00			`api/views/purchasing.batch`
Tweak `worksheet_update()` of ordering batch view, to leverage handler specifically this is to make use of handler's `update_row_quantity()` method, when user enters new order quantities via worksheet 2020-02-24 12:36:47 -06:00			`api/views/purchasing.ordering`
Add docs for new batch system. And some other tweak(s). 2015-02-13 01:12:20 -06:00

			`Documentation To-Do`
			`===================`

			`.. todolist::`
Initial docs (as generated by sphinx-quickstart). 2014-02-16 01:18:30 -06:00

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

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