Skip to content

Commit

Permalink
Merge pull request #601 from valpesendorfer/fix-docs
Browse files Browse the repository at this point in the history
Minor corrections for `configuration.rst` docs
  • Loading branch information
SpacemanPaul authored May 21, 2021
2 parents 9ba0498 + 2b6e6db commit 079d5e7
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ Configuration can be read from a python file, a json file, or a collection of py
and/or json files.

A json file can optionally also be fetched from AWS S3 if access to S3 is configured correctly for datacube_ows
and the environment variable ``$DATACUBE_OWS_CFG_ALLOW_S3`` is set to ``YES``. Please note that this is not
possible for configurations as python file.
and the environment variable ``$DATACUBE_OWS_CFG_ALLOW_S3`` is set to ``YES``. Please note that this is not
possible for configurations as python file.

.. _DATACUBE_OWS_CFG:

Expand All @@ -82,20 +82,20 @@ alternative applies):

Config loaded from **json** file in working directory.

5. Contains a dot (.), e.g. ``package.sub_package.module.cfg_object_name``

Imported as python object (expected to be a dictionary).

N.B. It is up to you to ensure that the Python file in question is in your Python path and
that all package directories have a ``__init__.py`` file, etc.

6. Has a valid ``s3://`` URL and a ``.json`` extension
5. Has a valid ``s3://`` URL and a ``.json`` extension

The configuration is fetched from AWS S3 in json format.

N.B. Configuration can only be loaded from S3 if the environment variable ``$DATACUBE_OWS_CFG_ALLOW_S3``
is set to ``yes``, otherwise a ``ConfigurationException`` will be raised.

6. Contains a dot (.), e.g. ``package.sub_package.module.cfg_object_name``

Imported as python object (expected to be a dictionary).

N.B. It is up to you to ensure that the Python file in question is in your Python path and
that all package directories have a ``__init__.py`` file, etc.

7. Valid python object name, e.g. ``cfg_prod``

Imported as **python** from named object in ``datacube_ows/ows_cfg.py``
Expand Down

0 comments on commit 079d5e7

Please sign in to comment.