Add most of the structure! plus several Base Layer docs

This commit is contained in:
Lance Edgar 2021-01-07 16:48:14 -06:00
parent 3704b59b8d
commit 98d6961370
48 changed files with 1076 additions and 8 deletions

View file

@ -1,15 +1,38 @@
.. rattail-guide documentation master file, created by
sphinx-quickstart on Wed Jan 6 15:33:34 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to rattail-guide's documentation!
=========================================
Rattail Manual
==============
This is "the reference manual" for Rattail, intended primarily for developers.
It assumes the reader is involved with the creation, customization and/or
maintenance of a Poser/Rattail app. It tries to explain the concepts involved
and hopefully tie them all together.
If you prefer step-by-step instructions for creating your own app then see also
the `Rattail Tutorial`_.
.. _Rattail Tutorial: https://rattailproject.org/docs/rattail-tutorial/
This manual is primarily organized according to the possible "layers" of a
Poser/Rattail app:
* :doc:`base/index` - general app install, command line, plus filemon etc.
* :doc:`data/index` - when a DB or data import/export come into it
* :doc:`web/index` - all things web
* :doc:`luigi/index` - using Luigi for better overnight automation
* :doc:`deploy/index` - deals with production deployment
* :doc:`backup/index` - backing up the production system
.. toctree::
:maxdepth: 2
:caption: Contents:
readfirst
base/index
data/index
web/index
luigi/index
deploy/index
backup/index
Indices and tables