Skip to content

Commit

Permalink
Add a quick overview to docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
akaIDIOT committed Sep 6, 2022
1 parent aa27d41 commit f4c1f04
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ confidence uses a similarly flexible, but deterministic approach to combining in
If that sounds awfully complicated, there's no requirement that you need to use anything that feels complicated.
See the :ref:`examples <examples>`, ranging from very simple to more complex uses of confidence' capabilities.

As a quick overview, confidence contains the following features:

- dict-like `Configuration` object supporting attribute access to configured values;
- customizable loading of multiple sources (files, environment variables, …) into a single object with deterministic precedence of those sources;
- the ability to make and resolve references to values or entire namespaces.

Contents
--------

Expand All @@ -19,9 +25,6 @@ Contents
api
glossary

Changelog
---------

.. todo::

Integrate ``CHANGES.md`` here without having to duplicate it.
Expand Down

0 comments on commit f4c1f04

Please sign in to comment.