xref: /aosp_15_r20/external/pigweed/pw_config_loader/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _module-pw_config_loader:
2
3----------------
4pw_config_loader
5----------------
6This directory contains the code to extract specific sections of user-specific
7configuration files for different parts of Pigweed.
8
9There are two different supported structures for extracting sections:
10
11.. code-block:: yaml
12
13   section_title:
14     foo: bar
15
16.. code-block:: yaml
17
18   config_title: section_title
19   foo: bar
20
21In addition, section titles can be nested:
22
23.. code-block:: yaml
24
25   section_title:
26     subtitle:
27       subsubtitle:
28         foo: bar
29
30.. code-block:: yaml
31
32   config_title: section_title.subtitle.subsubtitle
33   foo: bar
34
35Similar data structures are also supported in JSON and TOML.
36