Add some docs for commands, scripts, available settings
This commit is contained in:
parent
8e95813e2b
commit
70e538ca60
17 changed files with 224 additions and 23 deletions
5
docs/base/config/available/bouncer.rst
Normal file
5
docs/base/config/available/bouncer.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for bouncer
|
||||
====================
|
||||
|
||||
TODO
|
5
docs/base/config/available/common.rst
Normal file
5
docs/base/config/available/common.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Common Settings
|
||||
===============
|
||||
|
||||
TODO
|
5
docs/base/config/available/datasync.rst
Normal file
5
docs/base/config/available/datasync.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for datasync
|
||||
=====================
|
||||
|
||||
TODO
|
5
docs/base/config/available/db.rst
Normal file
5
docs/base/config/available/db.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for DB connections
|
||||
===========================
|
||||
|
||||
TODO
|
5
docs/base/config/available/email.rst
Normal file
5
docs/base/config/available/email.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for email
|
||||
==================
|
||||
|
||||
TODO
|
5
docs/base/config/available/filemon.rst
Normal file
5
docs/base/config/available/filemon.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for filemon
|
||||
====================
|
||||
|
||||
TODO
|
16
docs/base/config/available/index.rst
Normal file
16
docs/base/config/available/index.rst
Normal file
|
@ -0,0 +1,16 @@
|
|||
|
||||
Available Settings
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
overview
|
||||
common
|
||||
email
|
||||
db
|
||||
web
|
||||
datasync
|
||||
filemon
|
||||
bouncer
|
18
docs/base/config/available/overview.rst
Normal file
18
docs/base/config/available/overview.rst
Normal file
|
@ -0,0 +1,18 @@
|
|||
|
||||
Overview
|
||||
========
|
||||
|
||||
All settings are (usually) optional, meaning the app will fall back to some
|
||||
default value if the setting is not found in config. And you can put
|
||||
essentially whatever you like in your config file (or the DB ``setting``
|
||||
table), so in that sense "all settings are available".
|
||||
|
||||
But what we want to do here is, define certain common ("available") settings
|
||||
which any given Poser/Rattail app can leverage if needed, because the logic to
|
||||
do so is part of the underlying framework.
|
||||
|
||||
We will present each in terms of how they would be defined in a config file, as
|
||||
opposed to DB table. Often you can store the setting in the DB if you prefer,
|
||||
but in some cases the setting *must* be stored within a config file, because
|
||||
the app logic will only read it from file, and ignore the DB value. For more
|
||||
info see :doc:`../overview` and :doc:`../db`.
|
5
docs/base/config/available/web.rst
Normal file
5
docs/base/config/available/web.rst
Normal file
|
@ -0,0 +1,5 @@
|
|||
|
||||
Settings for web
|
||||
================
|
||||
|
||||
TODO
|
|
@ -1,11 +0,0 @@
|
|||
|
||||
Defined Settings
|
||||
================
|
||||
|
||||
There are a number of config settings which a given Poser/Rattail app may
|
||||
leverage. Most if not all are optional. We'll try to describe them here.
|
||||
|
||||
Note that we will present each in terms of a "section" and "option" pair,
|
||||
i.e. using the naming convention found in a config file vs. that of DB.
|
||||
|
||||
TODO!
|
|
@ -13,4 +13,4 @@ Configuration
|
|||
generate
|
||||
logging
|
||||
db
|
||||
defined
|
||||
available/index
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue