diff options
| author | mathieui <mathieui@mathieui.net> | 2013-05-11 18:38:12 +0200 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2013-05-11 18:38:12 +0200 |
| commit | 1a349efeb17ede2e744eb94c4217081a384af8b2 (patch) | |
| tree | ae97f1d2d7bf6fdd8a5786af1d282949cee37655 /doc | |
| parent | dde153e85b257de453c9587a09881af0649b5c16 (diff) | |
| download | poezio-1a349efeb17ede2e744eb94c4217081a384af8b2.tar.gz poezio-1a349efeb17ede2e744eb94c4217081a384af8b2.tar.bz2 poezio-1a349efeb17ede2e744eb94c4217081a384af8b2.tar.xz poezio-1a349efeb17ede2e744eb94c4217081a384af8b2.zip | |
Update the documentation
(do not encourage people to copy the plugins)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/plugins/index.rst | 6 | ||||
| -rw-r--r-- | doc/stub/config.py | 1 |
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst index 80fb6f9a..5fbbfdc2 100644 --- a/doc/source/plugins/index.rst +++ b/doc/source/plugins/index.rst @@ -8,12 +8,16 @@ Here is a quick howto and a plugin index. Setting up plugins ------------------ + Poezio seeks the plugins in the :file:`~/.local/share/poezio/plugins/` dir (more generally, the :file:`$XDG_DATA_HOME/poezio/plugins/` dir), but that can be changed by setting the :term:`plugins_dir` option to the directory where you want to put your plugins. -This means that if you want to use a plugin, you have to copy it (the .py file or the directory) into :term:`plugins_dir`. +By default, poezio will also seek the plugins in :file:`../plugins`, in the source +directory, in order to always load the latest versions. You should put a plugin +in :file:`$XDG_DATA_HOME/poezio/plugins` only if you have a custom version (that +will override the one in :file:`../plugins`), or if it is a plugin you made. Plugin autoload diff --git a/doc/stub/config.py b/doc/stub/config.py index 4ad01f7a..2bfe5b55 100644 --- a/doc/stub/config.py +++ b/doc/stub/config.py @@ -19,6 +19,7 @@ from args import parse_args from common import safeJID + class Config(RawConfigParser): """ load/save the config to a file |