Skip to content

Commit

Permalink
Add a JSON config file example for the CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sleepyhollo authored and waylan committed Jul 15, 2019
1 parent d0d7131 commit 7dce2ae
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/cli.md
Expand Up @@ -160,9 +160,23 @@ myext:
option2: True
```

Similarly, a JSON configuration file might look like this:

```json
{
"myext":
{
"option1": "value1",
"option2": "value2"
}
}
```

Note that while the `--extension_configs` option does specify the
`myext` extension, you still need to load the extension with the `-x` option,
or the configuration for that extension will be ignored.
or the configuration for that extension will be ignored. Further, if an
extension requires a value that cannot be parsed in JSON (for example a
reference to a function), one has to use a YAML configuration file.

The `--extension_configs` option will only support YAML configuration files if
[PyYAML] is installed on your system. JSON should work with no additional
Expand Down

0 comments on commit 7dce2ae

Please sign in to comment.