wutta/wuttjamaican
3
0
Fork 0
Code Issues Activity

docs: improve docs relating to app db, setup thereof

Browse source
This commit is contained in:
Lance Edgar 2024-12-08 12:19:42 -06:00
parent d70df11be6
commit 45ea5c5bdc
9 changed files with 241 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/narr/db/index.rst
View file

@ -2,9 +2,21 @@
Databases
=========
.. toctree::
:maxdepth: 2
Most :term:`apps <app>` based on WuttJamaican will have an :term:`app
database`. This may be used to store :term:`config settings <config
setting>` but usually, lots of other things.
Each app can declare its :term:`app model` which is essentially the
list of tables, each mapped to a Python class via SQLAlchemy ORM. The
default app model is :mod:`wuttjamaican.db.model`.
But of course any other :term:`database(s) <database>` may be
involved, for integration purposes etc. So there are some
conveniences around that too.
.. toctree::
:maxdepth: 3
overview
app
other