Add narrative docs for app configuration
This commit is contained in:
parent
f9a7b41f94
commit
4641e24afd
11 changed files with 596 additions and 47 deletions
72
docs/glossary.rst
Normal file
72
docs/glossary.rst
Normal file
|
@ -0,0 +1,72 @@
|
|||
.. _glossary:
|
||||
|
||||
Glossary
|
||||
========
|
||||
|
||||
.. glossary::
|
||||
:sorted:
|
||||
|
||||
app
|
||||
Depending on context, may refer to the software application
|
||||
overall, or the :term:`app handler`.
|
||||
|
||||
app database
|
||||
The main database used by the :term:`app`. There is normally
|
||||
just one database (for simple apps) which uses PostgreSQL for the
|
||||
backend.
|
||||
|
||||
app handler
|
||||
Python object representing the core of the :term:`app`. There is
|
||||
normally just one "global" app handler, which is an instance of
|
||||
:class:`~wuttjamaican.app.AppHandler`.
|
||||
|
||||
app name
|
||||
The code-friendly name for the :term:`app`
|
||||
(e.g. ``wutta_poser``). This is available on the :term:`config
|
||||
object` within Python as
|
||||
:attr:`~wuttjamaican.conf.WuttaConfig.appname`.
|
||||
|
||||
See also the human-friendly :term:`app title`.
|
||||
|
||||
app title
|
||||
The human-friendly name for the :term:`app` (e.g. "Wutta Poser").
|
||||
|
||||
See also the code-friendly :term:`app name`.
|
||||
|
||||
command
|
||||
A top-level command line interface for the app. Note that
|
||||
top-level commands don't really "do" anything per se, and are
|
||||
mostly a way to group :term:`subcommands<subcommand>`. See also
|
||||
:class:`~wuttjamaican.commands.base.Command`.
|
||||
|
||||
config
|
||||
Depending on context, may refer to any of: :term:`config file`,
|
||||
:term:`config object`, :term:`config setting`. See also
|
||||
:doc:`narr/config/index`.
|
||||
|
||||
config file
|
||||
A file which contains :term:`config settings<config setting>`.
|
||||
See also :doc:`narr/config/files`.
|
||||
|
||||
config object
|
||||
Python object representing the full set of :term:`config
|
||||
settings<config setting>` for the :term:`app`. Usually it gets
|
||||
some of the settings from :term:`config files<config file>`, but
|
||||
it may also get some from the :term:`settings table`. See also
|
||||
:doc:`narr/config/object`.
|
||||
|
||||
config setting
|
||||
The value of a setting as obtained from a :term:`config object`.
|
||||
Depending on context, sometimes this refers specifically to
|
||||
values obtained from the :term:`settings table` as opposed to
|
||||
:term:`config file`. See also :doc:`narr/config/settings`.
|
||||
|
||||
settings table
|
||||
Table in the :term:`app database` which is used to store
|
||||
:term:`config settings<config setting>`.
|
||||
|
||||
subcommand
|
||||
A top-level :term:`command` may expose one or more subcommands,
|
||||
for the overall command line interface. Subcommands are the real
|
||||
workhorse; each can perform a different function. See also
|
||||
:class:`~wuttjamaican.commands.base.Subcommand`.
|
Loading…
Add table
Add a link
Reference in a new issue