diff options
| author | Christopher Allan Webber <cwebber@dustycloud.org> | 2013-05-08 10:57:23 -0500 |
|---|---|---|
| committer | Christopher Allan Webber <cwebber@dustycloud.org> | 2013-05-08 11:03:09 -0500 |
| commit | f65bf8983611b18ec3a6a042404c50b8558529df (patch) | |
| tree | 010fa9e971afc9fea7de3a71ed256e896281b1f0 /docs/source/pluginwriter | |
| parent | d3604e29205c96877a6eb3fd5b1189ee0742382b (diff) | |
| download | mediagoblin-f65bf8983611b18ec3a6a042404c50b8558529df.tar.lz mediagoblin-f65bf8983611b18ec3a6a042404c50b8558529df.tar.xz mediagoblin-f65bf8983611b18ec3a6a042404c50b8558529df.zip | |
Documenting plugin configuration
This commit sponsored by David Krupicz. Thanks, David!
Diffstat (limited to 'docs/source/pluginwriter')
| -rw-r--r-- | docs/source/pluginwriter/api.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/source/pluginwriter/api.rst b/docs/source/pluginwriter/api.rst index 6323f713..df933511 100644 --- a/docs/source/pluginwriter/api.rst +++ b/docs/source/pluginwriter/api.rst @@ -32,3 +32,19 @@ Please check the release notes for updates! :members: get_config, register_routes, register_template_path, register_template_hooks, get_hook_templates, hook_handle, hook_runall, hook_transform + +Configuration +------------- + +Your plugin may define its own configuration defaults. + +Simply add to the directory of your plugin a config_spec.ini file. An +example might look like:: + + [plugin_spec] + some_string = string(default="blork") + some_int = integer(default=50) + +This means that when people enable your plugin in their config you'll +be able to provide defaults as well as type validation. + |