docs.rst

Configuration

Lorum ipsum gooble gabble

Option	Description	Environment Variable	Default
database.host	The hostname of the database server.		Must be supplied
database.db	The name of the database to connect to.		app
database.username	The username used to connect to the database server.	APP_DB_USERNAME	app
database.password	The password used to connect to the database server.	APP_DB_PASSWORD	Must be supplied
default-driver	Some of these options will have quite a lot of text needed to decribe them. Probably with links off to the relevant documentation section, but not sure the Sphinx theme I'm using renders these potentially very wide tables well?	APP_DRIVER	'driver1'

environment

APP_DB_USERNAME = xxx
APP_DB_PASSWORD = xxx
APP_SERVICE_TOKEN = XXX
APP_DRIVER = driver1
APP_OPTION1_DRIVER = 100

example-config.yaml

database:
  host: xxx
  db: xx
  username: xxx
  password: xx
  
some-web-service:
  url: https://xxx
  token: XXX
  
default-driver: driver1

drivers:
  driver1: 
    class: foo.bar.Baz
    option1: 100
    option2: 200
  driver2: 
    class: foo.bar.Bob
    option3: True

drivers
=======

driver1
-------

=======  ===========  ===========================  ==================
Name     Value        Description                  Env Var Override
=======  ===========  ===========================  ==================
class    foo.bar.Baz  Lorum ipsum gooble gabble    None
option1  100          Lorum ipsum gooble gabble    APP_OPTION1_DRIVER
option2  200          Lorum ipsum gooble gabble    None
=======  ===========  ===========================  ==================

driver2
-------

=======  ===========  ===========================  ==================
Name     Value        Description                  Env Var Override
=======  ===========  ===========================  ==================
class    foo.bar.Bob  Lorum ipsum gooble gabble    None
option3  True         Lorum ipsum gooble gabble    None
=======  ===========  ===========================  ==================

database options
================

``host``
    The hostname of the database server.

    :Environment Variable: None
    :Default: *Must be supplied*

``db``
    The name of the database to connect to.

    :Environment Variable: None
    :Default: ``app``

``username``
    The username used to connect to the database server.

    :Environment Variable: ``APP_DB_USERNAME``
    :Default: ``app``

``password``
    The password used to connect to the database server.

    :Environment Variable: ``APP_DB_PASSWORD``
    :Default: *Must be supplied*

``default-driver``
    Some of these options will have quite a lot of text needed to decribe them.
    Probably with `links`__ off to the relevant documentation section, but not sure the Sphinx theme I'm using renders these potentially very wide tables well?

    __ http://www.example.com

    :Environment Variable: ``APP_DRIVER``
    :Default: ``'driver1'``